Project::GetLTStrVars

GetLTStrVars

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 header to Include

Description

It retrieves the list of all string LabTalk variables.

Syntax

int GetLTStrVars( vector<string> & vsNames, vector<string> & vsValues = NULL, BOOL bUserVarsOnly = TRUE )

Parameters

vsNames: [output]the vector which will receive the names of all string Labtalk variables.
vsValues: [output,optional]the vector which will receive the values of all the string Labtalk variables.
bUserVarsOnly: [optional]if TRUE, it will only user string variables, otherwise it will list all string variables.

Return

the count of the retrieved variables.

Examples

EX1

// The example list all the string LabTalk variables currently in the project.
void        Project_GetLTStrVars_ex1()
{
    vector<string>        vsNames;
    vector<string>        vsValues;
    int                    nCount = Project.GetLTStrVars(vsNames, vsValues, FALSE);
    for (int ii = 0; ii < nCount; ii++)
    {
        printf("name: %s\t value = %s\n", vsNames[ii], vsValues[ii]);
    }
    
    return;
}