IPXV_BookmList::InsertFrom Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in]                    IPXV_BookmList*  Src,
+
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in]                    IPXV_BookmList*  pSrc,
                   [in, defaultvalue(0)]  ULONG            StartSrcIndex,
+
                   [in, defaultvalue(0)]  ULONG            nStartSrcIndex,
                   [in, defaultvalue(-1)]  ULONG            SrcItemsCount,
+
                   [in, defaultvalue(-1)]  ULONG            nSrcItemsCount,
                   [in, defaultvalue(-1)]  ULONG            DstIndex);</pre>
+
                   [in, defaultvalue(-1)]  ULONG            nDstIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Src
+
;pSrc
 
:[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
+
;nStartSrcIndex
 
:[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
+
;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 '''StartSrcIndex''' will be copied.
+
:[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.
;DstIndex
+
;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 '''DstIndex''' exceeds the maximum number in the destination list, then these bookmrks will be appended to the end of the destination list.
+
:[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 ==

Latest revision as of 02:48, 15 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.

See Also

IPXV_BookmList