IPXS_PDFVariant::Arr_InsertStringR Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IPXS_PDFVariant::Arr_InsertStringR Method}} | {{#customTitle:IPXS_PDFVariant::Arr_InsertStringR Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertStringR|method}} | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_InsertStringR|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 9: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Arr_InsertStringR([in] UCHAR* | + | <pre class="brush:cpp;gutter:false">HRESULT Arr_InsertStringR([in] UCHAR* nVal, |
[in] ULONG nValLen, | [in] ULONG nValLen, | ||
[in, defaultvalue(-1)] ULONG nBefore);</pre> | [in, defaultvalue(-1)] ULONG nBefore);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;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] | + | :[in] Specifies number of bytes in raw name representation. |
;nBefore | ;nBefore | ||
| − | :[in, defaultvalue(-1)] | + | :[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:07, 21 August 2015
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.
