Share this page

# vtc.updateMessageIfequals

Replaces the data in a field if the current data equals a given value.

## Syntax

    vtc.updateMessageIfequals ( columnName, rowIndex , value, ifEqualValue );

Example | Data Update Functions

## Arguments

name | Comments
--- | ---
columnName | The column to write to.
rowIndex | The number of the row. The first row has index 1.
value | The value to set the field to.
ifEqualValue | The value to compare the current value of the field to.

vtc.updateMessageIfequals writes the value to the field specified with the column name and row index if the value of the field when vtc.updateMessageIfequals is called is equal to the ifEqualValue. If the ifEqualValue and the field value match, the field value is overwritten.

## 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: