Share this page

# vtc.retrieveMessage

Pops the first field from a column.

## Syntax

    vtc.retrieveMessage ( columnname );

Example | Query Functions

## Arguments

name | Comments
--- | ---
columnname | The name of the column.

vtc.retrieveMessage retrieves the value from the field in the top row of the specified column. The value is stored in a parameter with the same name as the column.

All fields below the first row move up one row. For example, after the call, the value that was in the second row in the column is in the first row, the value that was in the third row is in the second row, and so on. The last field in the column is cleared.

## Return Values

Returns zero on success or one of the Error Codes.

## Parameterization

All string input arguments can be passed using standard parameterization.

## Example

    function callback(){
        var name = 'x' + arguments.callee.caller.arguments.callee.caller;
        lr.message( name.match(',(.*)_wrapper')[1] + '\'s callback arg:');
        for(var i=0 ;i<arguments.length; ++i){
            lr.message( 'arg[' + i + '] type: ' + typeof arguments[i] + ' =' + arguments[i]);
        }
    }

    function Action()
    {
        var handle2 = vtc.connect('321.321.321.321', 8889, vtc.VTOPT_KEEP_ALIVE);
        var handle1 = vtc.connect('123.123.123.123', 8888, vtc.VTOPT_KEEP_ALIVE);
        lr.message('handle1: '+ handle1.handle + ' handle2: ' + handle2.handle);

        if(handle2.handle!==0){
            handle2.createColumn('CID_2', callback );
            handle2.updateMessage('CID_2', 1, 'bbbb', callback );
        }

        if(handle1.handle!==0){
            handle1.createColumn('CID_1', callback );
            handle1.sendMessage('CID_1', '111', callback );
            handle1.sendMessage('CID_1', '2222', callback );
            handle1.updateMessage('CID_1', 1, 'aaaaa', callback );
            handle1.columnSize('CID_1', callback );
            handle1.queryColumn('CID_1', 1, callback );
            handle1.rotateRow(vtc.VTSEND_SAME_ROW, callback );
            handle1.queryRow(1, callback );
            handle1.rotateMessage('CID_1', vtc.VTSEND_SAME_ROW, callback );
            handle1.rotateMessages1('CustomerID,CompanyName', ',', vtc.VTSEND_SAME_ROW, callback );
            handle1.clearColumn('CID_1', callback );
            handle1.getLastError( callback );
            handle1.disconnect( callback );
        }

        if(handle2.handle!==0){
            handle2.disconnect( callback );
        }
    }

Tips to improve your search results... VuGen Function Reference Version 25.1-25.3 Function Reference 25.1-25.3 All View Local Help Center View Online Help Center Version: