IPXC_ActionsList::AddGotoR Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_ActionsList::AddGotoR Method}} | {{#customTitle:IPXC_ActionsList::AddGotoR Method}} | ||
| + | {{#parentPage:PXV:IPXC_ActionsList#Methods|AddGotoR|method}} | ||
Adds new GoToR action from the [[PXV:PXC_Destination|destination structure]] to the actions list. | Adds new GoToR action from the [[PXV:PXC_Destination|destination structure]] to the actions list. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT AddGotoR([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT AddGotoR([in] BSTR pFileName, |
| + | [in] PXC_Destination sDest, | ||
| + | [out, retval] IPXC_Action** ppAction);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pFileName |
:[in] Path to the source file. | :[in] Path to the source file. | ||
| − | ; | + | ;sDest |
| − | :[in] Value of [[PXV:PXC_Destination|PXC_Destination]] containing the source destination structure | + | :[in] Value of [[PXV:PXC_Destination|PXC_Destination]] containing the source destination structure. |
| − | ; | + | ;ppAction |
| − | :[out, retval] Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the newly created action | + | :[out, retval] Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the newly created action. |
== 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:IPXC_ActionsList|IPXC_ActionsList]] | |
Latest revision as of 08:03, 23 May 2015
Adds new GoToR action from the destination structure to the actions list.
Syntax
HRESULT AddGotoR([in] BSTR pFileName,
[in] PXC_Destination sDest,
[out, retval] IPXC_Action** ppAction);
Parameters
- pFileName
- [in] Path to the source file.
- sDest
- [in] Value of PXC_Destination containing the source destination structure.
- ppAction
- [out, retval] Pointer to IPXC_Action containing the newly created action.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
