IPXS_PDFVariant::Arr_InsertNameR Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(3 intermediate revisions by one other user not shown)
Line 3: Line 3:
 
{{#customTitle:IPXS_PDFVariant::Arr_InsertNameR Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_InsertNameR Method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertNameR|method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertNameR|method}}
−
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
Insert new variant with type <code>PVT_Name</code> and specified value into array container.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT Arr_InsertNameR([in]                    UCHAR*  pVal,
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_InsertNameR([in]                    UCHAR*  nVal,
 
                         [in]                    ULONG  nValLen,
 
                         [in]                    ULONG  nValLen,
 
                         [in, defaultvalue(-1)]  ULONG  nBefore);</pre>
 
                         [in, defaultvalue(-1)]  ULONG  nBefore);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;pVal
+
;nVal
−
:[in]  Pointer to UCHAR.
+
:[in]  Pointer to array of UCHAR values, which represent name in raw format (same bytes as stored in pdf file, except preciding "'''/'''" character and with #?? sequences decoded, for example <code>/A#41</code> will be represented as two bytes array with hex codes <code>41 41</code>, or ASCII string <code>AA</code>).
 +
:Please note that this function has lower performance than [[PXV:IPXS_PDFVariant_Arr_InsertNameA|Arr_InsertNameA]] because '''Raw data''' >> '''name''' conversion, so it is strongly not recommended to use it when adding 'common' pdf names.
 
;nValLen
 
;nValLen
−
:[in]  Value of ULONG.
+
:[in]  Specifies number of bytes in raw name representation.
 
;nBefore
 
;nBefore
−
:[in, defaultvalue(-1)] 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 ==

Latest revision as of 05:52, 20 August 2015

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


Insert new variant with type PVT_Name and specified value into array container.

Syntax

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

Parameters

nVal
[in] Pointer to array of UCHAR values, which represent name in raw format (same bytes as stored in pdf file, except preciding "/" character and with #?? sequences decoded, for example /A#41 will be represented as two bytes array with hex codes 41 41, or ASCII string AA).
Please note that this function has lower performance than Arr_InsertNameA because Raw data >> name conversion, so it is strongly not recommended to use it when adding 'common' pdf names.
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_InsertNameR&oldid=47990"