IPXV_BookmList::InsertFrom Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXV_BookmList::InsertFrom Method}} | {{#customTitle:IPXV_BookmList::InsertFrom Method}} | ||
{{#parentPage:PXV:IPXV_BookmList#Methods|InsertFrom|method}} | {{#parentPage:PXV:IPXV_BookmList#Methods|InsertFrom|method}} | ||
| − | + | ||
Inserts items from the given bookmarks list. | Inserts items from the given bookmarks list. | ||
| Line 19: | Line 19: | ||
:[in, defaultvalue(0)] Start index in the source array of the items to copy. | :[in, defaultvalue(0)] Start index in the source array of the items to copy. | ||
;nSrcItemsCount | ;nSrcItemsCount | ||
| − | :[in, defaultvalue(-1)] Number of the items to copy from the source array starting from the start index. | + | :[in, defaultvalue(-1)] Number of the items to copy from the source array starting from the start index. If the default value (-1) is specified then ALL items beginning with the '''nStartSrcIndex''' will be copied. |
;nDstIndex | ;nDstIndex | ||
| − | :[in, defaultvalue(-1)] Index in the bookmarks list where the items from the source would be inserted. | + | :[in, defaultvalue(-1)] Index in the bookmarks list where the items from the source would be inserted. If the default value (-1) is specified or '''nDstIndex''' exceeds the maximum number in the destination list, then these bookmrks will be appended to the end of the destination list. |
== Return Value == | == Return Value == | ||
Revision as of 10:37, 10 June 2015
Inserts items from the given bookmarks list.
Syntax
HRESULT InsertFrom([in] IPXV_BookmList* pSrc,
[in, defaultvalue(0)] ULONG nStartSrcIndex,
[in, defaultvalue(-1)] ULONG nSrcItemsCount,
[in, defaultvalue(-1)] ULONG nDstIndex);
Parameters
- pSrc
- [in] Pointer to IPXV_BookmList containing the source bookmarks 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. If the default value (-1) is specified then ALL items beginning with the nStartSrcIndex will be copied.
- nDstIndex
- [in, defaultvalue(-1)] Index in the bookmarks list where the items from the source would be inserted. If the default value (-1) is specified or nDstIndex exceeds the maximum number in the destination list, then these bookmrks will be appended to the end of the destination list.
Return Value
Returns S_OK if operation was successful or error code in other cases.
