IPXV_Inst::Str2ID Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IPXV_Inst::Str2ID Method}} | {{#customTitle:IPXV_Inst::Str2ID Method}} | ||
| − | + | Converts string identifier to numerical identifier. | |
== Syntax == | == Syntax == | ||
| Line 9: | Line 9: | ||
== Parameters == | == Parameters == | ||
;''pStr'' | ;''pStr'' | ||
| − | :[in] Value of BSTR. | + | :[in] Value of BSTR containing string identifier. |
;''bAddIfNotExists'' | ;''bAddIfNotExists'' | ||
| − | :[in, optional] | + | :[in, optional] Indicates whether to add ''pStr'' to the table of strings. Default value is '''TRUE'''. |
;''pID'' | ;''pID'' | ||
| − | :[out, retval] Pointer to LONG. | + | :[out, retval] Pointer to LONG value to receive the numeric ID. |
== Return Value == | == Return Value == | ||
Revision as of 03:37, 21 March 2015
Converts string identifier to numerical identifier.
Contents
Syntax
HRESULT Str2ID([in] BSTR pStr, [in, optional] VARIANT_BOOL bAddIfNotExists, [out, retval] LONG* pID);
Parameters
- pStr
- [in] Value of BSTR containing string identifier.
- bAddIfNotExists
- [in, optional] Indicates whether to add pStr to the table of strings. Default value is TRUE.
- pID
- [out, retval] Pointer to LONG value to receive the numeric ID.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IPXV_Inst.
