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

lrvtc.rotateMessages1

Retrieves the first field from the specified columns and moves the values to the bottom.

Example Query Functions

Syntax

lrvtc.rotateMessages1 ( columnNames, sendflag );

Arguments

name Comments
columnNames The column name, separated by the delimiter.
delimiter The character that separates the column names and values in the lists. If a string, rather than a single character, is passed in delimiter, the string as a whole is the delimiter.
sendflag Specify how the value is added back to bottom. One of:
  • lrvtc.VTSEND_SAME_ROW - Send all the data to the same row.
  • lrvtc.VTSEND_STACKED - The data is sent to availables field at the bottom of each 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.rotateMessages1 retrieves the data in the first field of each specified columns, and stores it in a parameter with the same name as the source column. The data is removed from each first field and moved to the bottom of each 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.rotateMessages1('Country,City', ',', lrvtc.VTSEND_STACKED);
    lr.logMessage(lr.evalString('{Country},') + lr.evalString('{City}'));