IPXV_Inst::Str2ID Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
;pStr | ;pStr | ||
| − | :[in] | + | :[in] The string identifier to be converted to numeric ID. |
;bAddIfNotExists | ;bAddIfNotExists | ||
| − | :[in, defaultvalue(-1)] Indicates whether to add | + | :[in, defaultvalue(-1)] Indicates whether to add input string to the global table of string-identifiers. Default value is <tt>true</tt>. |
;pID | ;pID | ||
| − | :[out, retval] | + | :[out, retval] Returns the numeric ID. |
== Return Value == | == Return Value == | ||
Revision as of 15:43, 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 numeric ID.
- 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.
