IUIX_Inst::Str2ID Method

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

Converts string ID to numerical ID.

Syntax

HRESULT Str2ID([in]                    BSTR          Str,
               [in, defaultvalue(-1)]  VARIANT_BOOL  AddIfNotExists,
               [out, retval]           LONG*         ID);

Parameters

Str

[in] string ID to convert.

AddIfNotExists

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

ID

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

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IUIX_Inst