IPXV_BookmList::InsertFrom Method

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_BookmList::InsertFrom Method}}
 
{{#customTitle:IPXV_BookmList::InsertFrom Method}}
 +
{{#parentPage:PXV:IPXV_BookmList#Methods|InsertFrom|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts items from the given bookmarks list.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in] IPXV_BookmList* pSrc, [in, optional] ULONG nStartSrcIndex, [in, optional] ULONG nSrcItemsCount, [in, optional] ULONG nDstIndex);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT InsertFrom([in]                   IPXV_BookmList* pSrc,
 +
                  [in, defaultvalue(0)]   ULONG           nStartSrcIndex,
 +
                  [in, defaultvalue(-1)] ULONG           nSrcItemsCount,
 +
                  [in, defaultvalue(-1)] ULONG           nDstIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pSrc''
+
;pSrc
:[in]  Pointer to [[PXV:IPXV_BookmList|IPXV_BookmList]].
+
:[in]  Pointer to [[PXV:IPXV_BookmList|IPXV_BookmList]] containing the source bookmarks list.
;''nStartSrcIndex''
+
;nStartSrcIndex
:[in, optionalValue of ULONG.
+
:[in, defaultvalue(0)Start index in the source array of the items to copy.
;''nSrcItemsCount''
+
;nSrcItemsCount
:[in, optionalValue of ULONG.
+
:[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, optionalValue of ULONG.
+
:[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 ==
Line 21: Line 26:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_BookmList|IPXV_BookmList]].
+
[[PXV:IPXV_BookmList|IPXV_BookmList]]

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