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_retrieve_message

vtc_retrieve_message

Deprecated. Use lrvtc_retrieve_message. Pops the first field from a column.

C Language

VTCERR2 vtc_retrieve_message ( PVCI2 pvci, char *columnName, char **outvalue );

C# Language

string vts_multi.retrieve_message ( int pvci, string columnName );

Java Language

int Vtc.retrieve_message (  long pvci, string columnName, OutStrParameter outvalue );
Query Functions

Arguments

Name Comments
pvci The server connection handle.
columnName The name of the column.
outvalue The value the first field in the column.

vtc_retrieve_message retrieves the value from the field in the top row of the specified colummn. In C, the value is returned in outvalue.

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.

After using the output value, free the output buffer with vtc_free.

Return Values

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

C# Language: Returns the value of the field.

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 = 0;
unsigned short status;
char *outvalue = NULL;

rc = vtc_retrieve_message(pvci, "Col1", &outvalue);

...

vtc_free(outvalue);

    

C# Language Example

.Net Multiple Connection Example

Java Language Example

Java Multi-Connection Example