IPXV_ActionHandler::GetDescription Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_ActionHandler::GetDescription Method}} | {{#customTitle:IPXV_ActionHandler::GetDescription Method}} | ||
| − | {{#parentPage:PXV:IPXV_ActionHandler|GetDescription | + | {{#parentPage:PXV:IPXV_ActionHandler#Methods|GetDescription|method}} |
| − | + | ||
Gets description from the action. | Gets description from the action. | ||
| Line 9: | Line 9: | ||
<pre class="brush:cpp;gutter:false">HRESULT GetDescription([in] IPXV_Document* pDoc, | <pre class="brush:cpp;gutter:false">HRESULT GetDescription([in] IPXV_Document* pDoc, | ||
[in] IPXC_Action* pAction, | [in] IPXC_Action* pAction, | ||
| − | [out, retval] BSTR* | + | [out, retval] BSTR* sDesc);</pre> |
== Parameters == | == Parameters == | ||
| Line 16: | Line 16: | ||
;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. | ||
| − | ; | + | ;sDesc |
:[out, retval] Pointer to BSTR containing the resulting description. | :[out, retval] Pointer to BSTR containing the resulting description. | ||
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXV_ActionHandler|IPXV_ActionHandler]] | |
Latest revision as of 02:45, 15 June 2015
Gets description from the action.
Syntax
HRESULT GetDescription([in] IPXV_Document* pDoc,
[in] IPXC_Action* pAction,
[out, retval] BSTR* sDesc);
Parameters
- pDoc
- [in] Pointer to IPXV_Document containing the source document.
- pAction
- [in] Pointer to IPXC_Action containing the source action.
- sDesc
- [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.
