IPXS_PDFVariant::Arr_SetName Method

Latest revision as of 06:20, 21 August 2015

Replace specified element of array with new variant with type PVT_Name and specified value.

HRESULT Arr_SetName([in]  ULONG   nPos,
                    [in]  LPWSTR  sVal);

nPos: [in] Specifies index of element to replace. If it is greater or equal to array size function will return E_INVALIDARG.
sVal: [in] Pointer to null-terminated Unicode string, which will be converted to name value.; Please note that this function has much lower performance than Arr_SetNameA because Unicode >> Raw data >> name conversion, so it is strongly not recommended to use it when set 'common' pdf names

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IPXS_PDFVariant::Arr_SetName Method}}
+{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetName|method}}
+{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Replace specified element of array with new variant with type <code>PVT_Name</code> and specified value.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT Arr_SetName([in] ULONG nPos, [in] BSTR pVal);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT Arr_SetName([in]  ULONG   nPos,
+                    [in]  LPWSTR  sVal);</pre>
 == Parameters ==
-;''nPos''
+;nPos
-:[in]  Value of ULONG.
+:[in]  Specifies index of element to replace. If it is greater or equal to array size function will return <code>E_INVALIDARG</code>.
-;''pVal''
+;sVal
-:[in]  Value of BSTR.
+:[in]  Pointer to null-terminated Unicode string, which will be converted to name value.
+:Please note that this function has much lower performance than [[PXV:IPXS_PDFVariant_Arr_SetNameA|Arr_SetNameA]] because '''Unicode''' >> '''Raw data''' >> '''name''' conversion, so it is strongly not recommended to use it when set 'common' pdf names
 == Return Value ==
@@ Line 17: / Line 22: @@
 == See Also ==
-See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]