IPXV_Inst::Str2ID Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 1: | Line 1: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_Inst::Str2ID Method}} | {{#customTitle:IPXV_Inst::Str2ID Method}} | ||
| − | {{#parentPage:PXV:IPXV_Inst|method}} | + | {{#parentPage:PXV:IPXV_Inst|Str2ID Method|method}} |
{{ToReview}} | {{ToReview}} | ||
| Line 7: | Line 7: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Str2ID([in] BSTR pStr, [in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists, [out, retval] LONG* pID);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT Str2ID([in] BSTR pStr, |
| + | [in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists, | ||
| + | [out, retval] LONG* pID);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pStr |
:[in] Value of BSTR containing string identifier. | :[in] Value of BSTR containing string identifier. | ||
| − | ; | + | ;bAddIfNotExists |
:[in, defaultvalue(-1)] Indicates whether to add ''pStr'' to the table of strings. Default value is '''TRUE'''. | :[in, defaultvalue(-1)] 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. | :[out, retval] Pointer to LONG value to receive the numeric ID. | ||
Revision as of 06:26, 23 April 2015
Converts string identifier to numerical identifier.
Contents
Syntax
HRESULT Str2ID([in] BSTR pStr,
[in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists,
[out, retval] LONG* pID);
Parameters
- pStr
- [in] Value of BSTR containing string identifier.
- bAddIfNotExists
- [in, defaultvalue(-1)] 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.
