IWords::InsertFrom Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IWords::InsertFrom Method}} | {{#customTitle:IWords::InsertFrom Method}} | ||
| − | {{#parentPage:PXV:IWords|method | + | {{#parentPage:PXV:IWords#Methods|InsertFrom|method}} |
| − | + | ||
| − | + | ||
| − | + | ||
| + | Inserts items from the given words list. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in] IWords* pSrc, [in, defaultvalue(0)] ULONG nStartSrcIndex, [in, defaultvalue(-1)] ULONG nSrcItemsCount, [in, defaultvalue(-1)] ULONG nDstIndex);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in] IWords* pSrc, |
| + | [in, defaultvalue(0)] ULONG nStartSrcIndex, | ||
| + | [in, defaultvalue(-1)] ULONG nSrcItemsCount, | ||
| + | [in, defaultvalue(-1)] ULONG nDstIndex);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pSrc |
| − | :[in] Pointer to [[PXV:IWords|IWords]]. | + | :[in] Pointer to [[PXV:IWords|IWords]] containing the source words list. |
| − | ; | + | ;nStartSrcIndex |
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Start index in the source array of the items to copy. |
| − | ; | + | ;nSrcItemsCount |
| − | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] Number of the items to copy from the source array starting from the start index. |
| − | ; | + | ;nDstIndex |
| − | :[in, defaultvalue(-1)] | + | :[in, defaultvalue(-1)] Index in the words list where the items from the source would be inserted. |
== 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:IWords|IWords]] | |
Latest revision as of 16:12, 16 June 2015
Inserts items from the given words list.
Syntax
HRESULT InsertFrom([in] IWords* pSrc,
[in, defaultvalue(0)] ULONG nStartSrcIndex,
[in, defaultvalue(-1)] ULONG nSrcItemsCount,
[in, defaultvalue(-1)] ULONG nDstIndex);
Parameters
- pSrc
- [in] Pointer to IWords containing the source words list.
- nStartSrcIndex
- [in, defaultvalue(0)] Start index in the source array of the items to copy.
- nSrcItemsCount
- [in, defaultvalue(-1)] Number of the items to copy from the source array starting from the start index.
- nDstIndex
- [in, defaultvalue(-1)] Index in the words list where the items from the source would be inserted.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
