IPXV_Inst::Str2ID Method

From PDF XChange PDF SDK
Revision as of 03:58, 15 June 2015 by Dsbot (Talk | contribs) (Automatic page editing by robot)

Jump to: navigation, search


Converts string identifier to numerical identifier.

Syntax

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

Parameters

sStr
[in] The string identifier to be converted to number.
bAddIfNotExists
[in, defaultvalue(-1)] Indicates whether to add input string to the global table of string-identifiers. Default value is true.
nID
[out, retval] Returns the numeric ID.

Return Value

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

See Also

IPXV_Inst