IPXS_PDFVariant::Arr_SetStringR Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IPXS_PDFVariant::Arr_SetStringR Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_SetStringR Method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetStringR|method}}
 
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_SetStringR|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Replace specified element of array with new variant with type <code>PVT_String</code> and specified value.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
== Parameters ==
 
== 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>.
 
;nVal
 
;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]  Value of ULONG.

Latest revision as of 06:46, 21 August 2015


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

Syntax

HRESULT Arr_SetStringR([in]  ULONG   nPos,
                       [in]  UCHAR*  nVal,
                       [in]  ULONG   nValLen);

Parameters

nPos
[in] Specifies index of element to replace. If it is greater or equal to array size function will return E_INVALIDARG.
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] Value of ULONG.

Return Value

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

See Also

IPXS_PDFVariant