IUIX_Inst::ID2Str Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_Inst::ID2Str Method}}
 
{{#customTitle:IUIX_Inst::ID2Str Method}}
{{#parentPage:PXV:IUIX_Inst|method}}
+
{{#parentPage:PXV:IUIX_Inst#Methods|ID2Str|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Converts numerical ID to appropriate string ID.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT ID2Str([in] LONG nID, [out, retval] BSTR* ppStr);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ID2Str([in]           LONG   nID,
 +
              [out, retval] BSTR* sStr);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nID''
+
;nID
:[in]  Value of LONG.
+
:[in]  numerical ID to convert.
;''ppStr''
+
;sStr
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  return value of string ID.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_Inst|IUIX_Inst]].
+
[[PXV:IUIX_Inst|IUIX_Inst]]

Latest revision as of 11:28, 16 June 2015


Converts numerical ID to appropriate string ID.

Syntax

HRESULT ID2Str([in]           LONG   nID,
               [out, retval]  BSTR*  sStr);

Parameters

nID
[in] numerical ID to convert.
sStr
[out, retval] return value of string ID.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IUIX_Inst