IPXV_ActionHandler::GetDescription Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 2: Line 2:
 
{{#customTitle:IPXV_ActionHandler::GetDescription Method}}
 
{{#customTitle:IPXV_ActionHandler::GetDescription Method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets description from the action.
  
 
== Syntax ==
 
== Syntax ==
Line 9: Line 9:
 
== Parameters ==
 
== Parameters ==
 
;''pDoc''
 
;''pDoc''
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]].
+
:[in]  Pointer to [[PXV:IPXV_Document|IPXV_Document]] containing the source document.
 
;''pAction''
 
;''pAction''
:[in]  Pointer to [[PXV:IPXC_Action|IPXC_Action]].
+
:[in]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the source action.
 
;''ppDesc''
 
;''ppDesc''
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Pointer to BSTR containing the resulting description.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 03:27, 16 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.