IPXC_ActionsList::Insert Method
From PDF XChange PDF SDK
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_ActionsList::Insert Method}} | {{#customTitle:IPXC_ActionsList::Insert Method}} | ||
| + | {{#parentPage:PXV:IPXC_ActionsList#Methods|Insert|method}} | ||
| − | Inserts an existing action into the actions list into given position. Note that the position value | + | Inserts an existing action into the actions list into the given position. Note that the position value that is bigger or equal to the actions list size will insert the action as the last item of the actions list. |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Insert([in] ULONG nPos, [in] IPXC_Action* pAction);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT Insert([in] ULONG nPos, |
| + | [in] IPXC_Action* pAction);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nPos |
:[in] Position of the inserted action in the actions list. | :[in] Position of the inserted action in the actions list. | ||
| − | ; | + | ;pAction |
:[in] Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the action to be inserted into the actions list. | :[in] Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the action to be inserted into the actions list. | ||
== 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 01:24, 25 May 2015
Inserts an existing action into the actions list into the given position. Note that the position value that is bigger or equal to the actions list size will insert the action as the last item of the actions list.
Syntax
HRESULT Insert([in] ULONG nPos,
[in] IPXC_Action* pAction);
Parameters
- nPos
- [in] Position of the inserted action in the actions list.
- pAction
- [in] Pointer to IPXC_Action containing the action to be inserted into the actions list.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
