IPXS_PDFVariant::Arr_GetStringR Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IPXS_PDFVariant::Arr_GetStringR Method}} | {{#customTitle:IPXS_PDFVariant::Arr_GetStringR Method}} | ||
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetStringR|method}} | {{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetStringR|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | The | + | The Returns the value of a specified element of an array as array of bytes (raw data from PDF). If specified element type is not <code>PVT_String</code> or index is out of range function return <code>S_FALSE</code> and <code>nLen</code> is set to '''0''' (zero). |
== Syntax == | == Syntax == | ||
| Line 16: | Line 15: | ||
== Parameters == | == Parameters == | ||
;nIndex | ;nIndex | ||
| − | :[in] | + | :[in] Specifies the index of the array element. |
;nBuf | ;nBuf | ||
| − | :[out] | + | :[out] Pointer to UCHAR buffer, to which string data will be copied. If it is <code>NULL</code> no data copying required and <code>nLen</code> will receive size of raw data. If both of these pointers are <code>NULL</code> function will return <code>E_INVALIDARG</code>. |
;nBufLen | ;nBufLen | ||
| − | :[in] | + | :[in] Specify maximum size of raw data to be copied. |
;nLen | ;nLen | ||
| − | :[out] | + | :[out] Pointer to variable which receive raw data size (always, even when function copy some data into buffer with truncation). |
== Return Value == | == Return Value == | ||
Revision as of 07:22, 9 June 2015
The Returns the value of a specified element of an array as array of bytes (raw data from PDF). If specified element type is not PVT_String or index is out of range function return S_FALSE and nLen is set to 0 (zero).
Syntax
HRESULT Arr_GetStringR([in] ULONG nIndex,
[out] UCHAR* nBuf,
[in] ULONG nBufLen,
[out] ULONG* nLen);
Parameters
- nIndex
- [in] Specifies the index of the array element.
- nBuf
- [out] Pointer to UCHAR buffer, to which string data will be copied. If it is
NULLno data copying required andnLenwill receive size of raw data. If both of these pointers areNULLfunction will returnE_INVALIDARG. - nBufLen
- [in] Specify maximum size of raw data to be copied.
- nLen
- [out] Pointer to variable which receive raw data size (always, even when function copy some data into buffer with truncation).
Return Value
Returns S_OK if operation was successful or error code in other cases.
