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_retrieve_message

lrvtc_retrieve_message

Pops the first field from a column.

C Language

VTCERR2 lrvtc_retrieve_message ( char *columnName );

C# Language

void vts.retrieve_message ( string columnName );

Java Language

int Lrvtc.retrieve_message ( string columnName );
Query Functions

Arguments

Name Comments
columnName The name of the column.

lrvtc_retrieve_message retrieves the value from the field in the top row of the specified colummn. The value is stored in a parameter with the same name as the column.

All fields below the first row move up one row. For example, after the call, the value that was in the second row in the column is in the first row, the value that was in the third row is in the second row, and so on. The last field in the column is cleared.

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

    int rc;
    ...
    rc = lrvtc_retrieve_message("H_question");
    lr_log_message("Retrieve_message rc=%d\n", rc);
    lr_log_message("Retrieved value is: %s", lr_eval_string("{H_question}"));
    

C# Language Example

.Net Single Connection Example

Java Language Example

Java Single Connection Example