IUIX_Dialog::GetItemText 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_Dialog::GetItemText Method}}
 
{{#customTitle:IUIX_Dialog::GetItemText Method}}
{{#parentPage:PXV:IUIX_Dialog|method}}
+
{{#parentPage:PXV:IUIX_Dialog#Methods|GetItemText|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Gets text of a required dialog item by item's text ID.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetItemText([in] BSTR pItemID, [out, retval] BSTR* ppText);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetItemText([in]           BSTR   sItemID,
 +
                    [out, retval] BSTR* sText);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pItemID''
+
;sItemID
:[in]  Value of BSTR.
+
:[in]  text ID of a required item.
;''ppText''
+
;sText
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  return value of item text.
  
 
== 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_Dialog|IUIX_Dialog]].
+
[[PXV:IUIX_Dialog|IUIX_Dialog]]

Latest revision as of 15:20, 15 June 2015


Gets text of a required dialog item by item's text ID.

Syntax

HRESULT GetItemText([in]           BSTR   sItemID,
                    [out, retval]  BSTR*  sText);

Parameters

sItemID
[in] text ID of a required item.
sText
[out, retval] return value of item text.

Return Value

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

See Also

IUIX_Dialog