IPXS_PDFVariant::Arr_InsertStringR Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_InsertStringR Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_InsertStringR Method}}
 +
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertStringR|method}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT Arr_InsertStringR([in] UCHAR* pVal, [in] ULONG nValLen, [in, optional] ULONG nBefore);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_InsertStringR([in]                   UCHAR* nVal,
 +
                          [in]                   ULONG   nValLen,
 +
                          [in, defaultvalue(-1)] ULONG   nBefore);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''pVal''
+
;nVal
−
:[in]  Pointer to UCHAR.
+
:[in]  Pointer to array of UCHAR values, which represent string in raw format (same bytes as stored in pdf file, except escaped characters will be unescaped and octal characters will be decoded.
−
;''nValLen''
+
;nValLen
−
:[in]  Value of ULONG.
+
:[in]  Specifies number of bytes in raw name representation.
−
;''nBefore''
+
;nBefore
−
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(-1)]  Specifies index of element before which we will insert new one. If index is greater or equal array size new element will be inserted at the end of array.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Latest revision as of 06:07, 21 August 2015

PDF Structures Layer > Interfaces > IPXS_PDFVariant > IPXS_PDFVariant::Arr_InsertStringR Method


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Arr_InsertStringR([in]                    UCHAR*  nVal,
                          [in]                    ULONG   nValLen,
                          [in, defaultvalue(-1)]  ULONG   nBefore);

Parameters

nVal
[in] Pointer to array of UCHAR values, which represent string in raw format (same bytes as stored in pdf file, except escaped characters will be unescaped and octal characters will be decoded.
nValLen
[in] Specifies number of bytes in raw name representation.
nBefore
[in, defaultvalue(-1)] Specifies index of element before which we will insert new one. If index is greater or equal array size new element will be inserted at the end of array.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IPXS_PDFVariant

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXS_PDFVariant_Arr_InsertStringR&oldid=47994"