IPXV_Inst::Str2ID Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Str2ID([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT Str2ID([in] BSTR sStr, |
[in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists, | [in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists, | ||
| − | [out, retval] LONG* | + | [out, retval] LONG* nID);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sStr |
:[in] The string identifier to be converted to number. | :[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>. | ||
| − | ; | + | ;nID |
:[out, retval] Returns the numeric ID. | :[out, retval] Returns the numeric ID. | ||
Revision as of 01:41, 4 June 2015
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.
