IPXV_ActionHandler::GetDescription Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetDescription([in]          IPXV_Document*  pDoc,
+
<pre class="brush:cpp;gutter:false">HRESULT GetDescription([in]          IPXV_Document*  Doc,
                       [in]          IPXC_Action*    pAction,
+
                       [in]          IPXC_Action*    Action,
                       [out, retval]  BSTR*          sDesc);</pre>
+
                       [out, retval]  BSTR*          Desc);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pDoc
+
;Doc
 
:[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
+
;Action
 
:[in]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the source action.
 
:[in]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the source action.
;sDesc
+
;Desc
 
:[out, retval]  Pointer to BSTR containing the resulting description.
 
:[out, retval]  Pointer to BSTR containing the resulting description.
  

Revision as of 07:21, 12 June 2015

Gets description from the action.

Syntax

HRESULT GetDescription([in]           IPXV_Document*  Doc,
                       [in]           IPXC_Action*    Action,
                       [out, retval]  BSTR*           Desc);

Parameters

Doc
[in] Pointer to IPXV_Document containing the source document.
Action
[in] Pointer to IPXC_Action containing the source action.
Desc
[out, retval] Pointer to BSTR containing the resulting description.

Return Value

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

See Also

IPXV_ActionHandler