IPXV_Inst::Str2ID Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 14: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;pStr
 
;pStr
:[in]  The string identifier to be converted to numeric ID.
+
:[in]  The string identifier to be converted to number.
 
;bAddIfNotExists
 
;bAddIfNotExists
 
:[in, defaultvalue(-1)]  Indicates whether to add input string to the global table of string-identifiers. Default value is <tt>true</tt>.
 
:[in, defaultvalue(-1)]  Indicates whether to add input string to the global table of string-identifiers. Default value is <tt>true</tt>.

Revision as of 16:44, 25 May 2015


Converts string identifier to numerical identifier.

Syntax

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

Parameters

pStr
[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.
pID
[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