IUIX_Inst::Str2ID Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::Str2ID Method}}
 
{{#customTitle:IUIX_Inst::Str2ID Method}}
{{#parentPage:PXV:IUIX_Inst|Str2ID Method|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|Str2ID Method|method}}
 
{{ToReview}}
 
{{ToReview}}
  

Revision as of 22:45, 21 May 2015


Converts string ID to numerical ID.

Syntax

HRESULT Str2ID([in]                    BSTR          pStr,
               [in, defaultvalue(-1)]  VARIANT_BOOL  bAddIfNotExists,
               [out, retval]           LONG*         pID);

Parameters

pStr
[in] string ID to convert.
bAddIfNotExists
[in, defaultvalue(-1)] if this parameter is set to VARIANT_TRUE, method will register pStr string ID if it doesn't exist yet.
pID
[out, retval] return value of converted numerical ID.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IUIX_Inst.