IUIX_Inst::Str2ID Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IUIX_Inst::Str2ID Method}} | {{#customTitle:IUIX_Inst::Str2ID Method}} | ||
{{#parentPage:PXV:IUIX_Inst#Methods|Str2ID|method}} | {{#parentPage:PXV:IUIX_Inst#Methods|Str2ID|method}} | ||
| − | + | ||
Converts string ID to numerical ID. | Converts string ID to numerical ID. | ||
| Line 21: | Line 21: | ||
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
[[PXV:IUIX_Inst|IUIX_Inst]] | [[PXV:IUIX_Inst|IUIX_Inst]] | ||
Latest revision as of 10:41, 16 June 2015
Converts string ID to numerical ID.
Syntax
HRESULT Str2ID([in] BSTR sStr,
[in, defaultvalue(-1)] VARIANT_BOOL bAddIfNotExists,
[out, retval] LONG* nID);
Parameters
- sStr
- [in] string ID to convert.
- bAddIfNotExists
- [in, defaultvalue(-1)] if this parameter is set to VARIANT_TRUE, method will register sStr string ID if it doesn't exist yet.
- nID
- [out, retval] return value of converted numerical ID.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
