lrvtc.retrieveMessage

Pops the first field from a column.

ExampleQuery Functions

Syntax

lrvtc.retrieveMessage ( columnname );

Arguments

nameComments
columnnameThe name of the column.

lrvtc.retrieveMessage retrieves the value from the field in the top row of the specified column. 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

Returns zero on success or one of the Error Codes.

Parameterization

All string input arguments can be passed using standard parameterization.

Example

    var rc;
    ...
    rc = lrvtc.retrieveMessage("H_question");
    lr.logMessage("Retrieve_message rc="+ rc);
    lr.logMessage("Retrieved value is: " + lr.evalString("{H_question}"));