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. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in] IPXV_BookmList* | + | <pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in] IPXV_BookmList* Src, |
| − | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG StartSrcIndex, |
| − | [in, defaultvalue(-1)] ULONG | + | [in, defaultvalue(-1)] ULONG SrcItemsCount, |
| − | [in, defaultvalue(-1)] ULONG | + | [in, defaultvalue(-1)] ULONG DstIndex);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;Src |
:[in] Pointer to [[PXV:IPXV_BookmList|IPXV_BookmList]] containing the source bookmarks list. | :[in] Pointer to [[PXV:IPXV_BookmList|IPXV_BookmList]] containing the source bookmarks list. | ||
| − | ; | + | ;StartSrcIndex |
:[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. | ||
| − | ; | + | ;SrcItemsCount |
| − | :[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 ''' | + | :[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 '''StartSrcIndex''' will be copied. |
| − | ; | + | ;DstIndex |
| − | :[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 ''' | + | :[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 '''DstIndex''' 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 06:24, 12 June 2015
Inserts items from the given bookmarks list.
Syntax
HRESULT InsertFrom([in] IPXV_BookmList* Src,
[in, defaultvalue(0)] ULONG StartSrcIndex,
[in, defaultvalue(-1)] ULONG SrcItemsCount,
[in, defaultvalue(-1)] ULONG DstIndex);
Parameters
- Src
- [in] Pointer to IPXV_BookmList containing the source bookmarks list.
- StartSrcIndex
- [in, defaultvalue(0)] Start index in the source array of the items to copy.
- SrcItemsCount
- [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 StartSrcIndex will be copied.
- DstIndex
- [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 DstIndex 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.
