JavaScript Functions > Virtual Table Server Functions for Single Connection (lrvtc) > Alphabetical Listing of Virtual Table Server Functions (Single Server) > lrvtc.rotateMessage

lrvtc.rotateMessage

Retrieves the first field from the specified column and moves the value to the bottom.

Example Query Functions

Syntax

lrvtc.rotateMessage ( columnName, sendflag );

Arguments

name Comments
columnName The name of the column.
sendflag Specify how the value is added back to bottom. One of:
  • lrvtc.VTSEND_STACKED - The data is sent to an available field at the bottom of the column.
  • lrvtc.VTSEND_STACKED_UNIQUE - If the value of the first field already exists elsewhere in the column, the top field is retrieved and then discarded. Otherwise, data is sent to an available field at the bottom of the column.

lrvtc.rotateMessage retrieves the data in the first field of the column and stores it in a parameter with the same name as the column. The data is removed from the first field and moved to the bottom of the column as specified by the sendFlag.

If there is no data in a cell, the output is NULL.

Return Values

Returns zero on success or one of the Error codes.

Parameterization

All string input arguments can be passed using standard parameterization.

Example

    lrvtc.rotateMessage('Country', lrvtc.VTSEND_STACKED);
    lr.logMessage(lr.evalString('{Country}'));