IPXS_PDFVariant::Arr_GetStringR Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
−
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).
+
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>Len</code> is set to '''0''' (zero).
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetStringR([in]  ULONG  nIndex,
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetStringR([in]  ULONG  Index,
−
                       [out]  UCHAR*  nBuf,
+
                       [out]  UCHAR*  Buf,
−
                       [in]  ULONG  nBufLen,
+
                       [in]  ULONG  BufLen,
−
                       [out]  ULONG*  nLen);</pre>
+
                       [out]  ULONG*  Len);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;nIndex
+
;Index
 
:[in] Specifies the index of the array element.
 
:[in] Specifies the index of the array element.
−
;nBuf
+
;Buf
−
:[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>.
+
:[out] Pointer to UCHAR buffer, to which string data will be copied. If it is <code>NULL</code> no data copying required and <code>Len</code> will receive size of raw data. If both of these pointers are <code>NULL</code> function will return <code>E_INVALIDARG</code>.
−
;nBufLen
+
;BufLen
 
:[in] Specify maximum size of raw data to be copied.
 
:[in] Specify maximum size of raw data to be copied.
−
;nLen
+
;Len
 
:[out] Pointer to variable which receive raw data size (always, even when function copy some data into buffer with truncation).  
 
:[out] Pointer to variable which receive raw data size (always, even when function copy some data into buffer with truncation).  
  

Revision as of 07:18, 12 June 2015

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


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 Len is set to 0 (zero).

Syntax

HRESULT Arr_GetStringR([in]   ULONG   Index,
                       [out]  UCHAR*  Buf,
                       [in]   ULONG   BufLen,
                       [out]  ULONG*  Len);

Parameters

Index
[in] Specifies the index of the array element.
Buf
[out] Pointer to UCHAR buffer, to which string data will be copied. If it is NULL no data copying required and Len will receive size of raw data. If both of these pointers are NULL function will return E_INVALIDARG.
BufLen
[in] Specify maximum size of raw data to be copied.
Len
[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.

See Also

IPXS_PDFVariant

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXS_PDFVariant_Arr_GetStringR&oldid=42992"