Utility Functions and C Language Reference > Virtual Table Server Functions (VTS) for C, C#, and Java > Virtual Table Server (VTS) Functions for Multiple Connections > Alphabetical Listing > vtc_rotate_message

vtc_rotate_message

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

C Language

vtc_rotate_message ( PVCI2 pvci, char *columnName, char **outValues, unsigned char sendflag );

C# Language

bool vts_multi.rotate_message ( int pvci,  string columnName, string outvalue, string sendflag );

Java Language

int Vtc.rotate_message ( int pvci, String columnName, OutStrParameter outValue, int sendFlag );

Query Functions

Arguments

name Comments
pvci The server connection handle.
columnName The name of the column.
outValue Pointer to a string to store retrieved values.
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.

vtc_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 unsigned char 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.

C Language Example

    vtc_rotate_message(pvci, "Country", &outValue, VTSEND_STACKED);
    lr_log_message("%s", outValue);
    vtc_free(outValue);
	

C# Language Example

.Net Multiple Connection Example

Java Language Example

Java Multi-Connection Example