IPXV_ActionHandler::GetDescription Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_ActionHandler::GetDescription Method}}
 
{{#customTitle:IPXV_ActionHandler::GetDescription Method}}
{{#parentPage:PXV:IPXV_ActionHandler|method}}
+
{{#parentPage:PXV:IPXV_ActionHandler|GetDescription Method|method}}
 
{{ToReview}}
 
{{ToReview}}
  
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetDescription([in] IPXV_Document* pDoc, [in] IPXC_Action* pAction, [out, retval] BSTR* ppDesc);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetDescription([in]           IPXV_Document* pDoc,
 +
                      [in]           IPXC_Action*   pAction,
 +
                      [out, retval] BSTR*           ppDesc);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pDoc''
+
;pDoc
 
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] containing the source document.
 
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] containing the source document.
;''pAction''
+
;pAction
 
:[in]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the source action.
 
:[in]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the source action.
;''ppDesc''
+
;ppDesc
 
:[out, retval]  Pointer to BSTR containing the resulting description.
 
:[out, retval]  Pointer to BSTR containing the resulting description.
  

Revision as of 06:18, 23 April 2015


Gets description from the action.

Syntax

HRESULT GetDescription([in]           IPXV_Document*  pDoc,
                       [in]           IPXC_Action*    pAction,
                       [out, retval]  BSTR*           ppDesc);

Parameters

pDoc
[in] Pointer to IPXV_Document containing the source document.
pAction
[in] Pointer to IPXC_Action containing the source action.
ppDesc
[out, retval] Pointer to BSTR containing the resulting description.

Return Value

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

See Also

See also IPXV_ActionHandler.