FLGetVariable        Method to get the value of FileLink script variable

Overview

Method to get the value of the specified FileLink script variable. Note: this method does not work when the calling program is written in VBScript - use the FLGetVBSVariable method instead.

C++ Definition

long FLGetVariable( CString strVariable, CString strValue )

VB Definition

FLGetVariable( Variable As String, Value As String ) As Long

Return Value

A numeric value indicating the success or failure of obtaining the value FileLink variable.

Returns FL_ERROR_SUCCESS if the variable is found and its value is returned in the strValue / Value variable.

Returns FL_ERROR_VAR_NOT_FOUND if the variable is not defined.

See COM/OLE Return Codes for a complete list of possible return values.

Parameters

strVariable / Variable

A string defining the FileLink script variable name.

strValue / Value

A string that contains the value of the variable upon return.

Remarks

The StartSession() method must be called prior to calling FLGetVariable().