IUIX_Inst::Str2ID Method

UI Layer > Interfaces > IUIX_Inst > IUIX_Inst::Str2ID Method

Converts string ID to numerical ID.

Syntax

HRESULT Str2ID([in]                    BSTR          sStr,
               [in, defaultvalue(-1)]  VARIANT_BOOL  bAddIfNotExists,
               [out, retval]           LONG*         nID);

Parameters

sStr

[in] string ID to convert.

bAddIfNotExists

[in, defaultvalue(-1)] if this parameter is set to VARIANT_TRUE, method will register sStr string ID if it doesn't exist yet.

nID

[out, retval] return value of converted numerical ID.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst