GetValString Method

»Table of Contents

NI TestStand™ 4.1 Help
May 2008

NI Part Number:
370052G-01

»View NI TestStand Product Info

Syntax

PropertyObject.GetValString ( lookupString, options)

Return Value

String

String value of the property.

Purpose

Returns the string value of the property specified by the lookupString parameter.

Remarks

For numeric properties, calling this method with the PropOption_CoerceFromNumber option does not localize the resulting string. Use the PropertyObject.GetFormattedValue method to get a localized string for a number.

Parameters

lookupString As String

[In] Pass an empty string to denote the PropertyObject to which the method applies, or pass the name of a subproperty within the PropertyObject. Refer to Lookup Strings for more information about the strings you can use.

options As Long

[In] Pass 0 to specify the default behavior, or pass one or more PropertyOptions constants. Use the bitwise-OR operator to specify multiple options.

Example

LabWindows/CVI:
    char *stringVal = NULL;

    TS_PropertyGetValString(propObj, &errorInfo, "Step.Limits.String",
                            0, &stringVal);
    CA_FreeMemory(stringVal);

Visual Basic (function call):
    Dim stringVal As String

    stringVal = propObj.GetValString("Step.Limits.String", 0)

Visual Basic (inline):
    Dim stringVal As String

    stringVal = propObj.Step.Limits.String

Visual C++:
    _bstr_t stringVal;

    stringVal = propObj->GetValString("Step.Limits.String", 0);