IWords::Insert Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(7 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IWords::Insert Method}}
 
{{#customTitle:IWords::Insert Method}}
{{#parentPage:PXV:IWords|Insert Method|method}}
+
{{#parentPage:PXV:IWords#Methods|Insert|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
 
 +
Inserts item into words list.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Insert([in]                    BSTR  pItem,
+
<pre class="brush:cpp;gutter:false">HRESULT Insert([in]                    BSTR  sItem,
 
               [in, defaultvalue(-1)]  ULONG  nIndex);</pre>
 
               [in, defaultvalue(-1)]  ULONG  nIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pItem
+
;sItem
:[in]  Value of BSTR.
+
:[in]  Item that would be inserted into the words list.
 
;nIndex
 
;nIndex
:[in, defaultvalue(-1)]  Value of ULONG.
+
:[in, defaultvalue(-1)]  The index in the words list where the item would be inserted.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.  
  
 
== See Also ==
 
== See Also ==
[[PXV:IWords|IWords]].
+
[[PXV:IWords|IWords]]

Latest revision as of 16:11, 16 June 2015


Inserts item into words list.

Syntax

HRESULT Insert([in]                    BSTR   sItem,
               [in, defaultvalue(-1)]  ULONG  nIndex);

Parameters

sItem
[in] Item that would be inserted into the words list.
nIndex
[in, defaultvalue(-1)] The index in the words list where the item would be inserted.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IWords