Utility Functions and C Language Reference > Virtual Table Server Functions (VTS) for C, C#, and Java > Virtual Table Server (VTS) Functions for Single Connection > Alphabetical Listing > lrvtc_rotate_message

lrvtc_rotate_message

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

C Language

lrvtc_rotate_message ( columnName, sendflag );

C# Language

void vts.rotate_message ( string columnName,string sendflag  );

Java Language

int Lrvtc.rotate_message ( String columnName, int sendFlag );

Query Functions

Arguments

name Comments
columnName The name of the column.
sendflag Specify how the value is added back to bottom. One of:
  • VTSEND_STACKED - The data is sent to an available field at the bottom of the column.
  • 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_rotate_message 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

C Language:   Returns zero on success or one of the Error Codes.

C# Language: No return value.

Java Language:   Returns zero on success or one of the Error Codes.

Parameterization

All string input arguments can be passed using standard parameterization.

C Language Example

    lrvtc_rotate_message("Country", VTSEND_STACKED);
    lr_log_message(lr_eval_string("{Country}"));

C# Language Example

.Net Single Connection Example

Java Language Example

Java Single Connection Example