IPXS_PDFVariant::Arr_GetString Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Arr_GetString Method}}
 
{{#customTitle:IPXS_PDFVariant::Arr_GetString Method}}
 +
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Arr_GetString|method}}
 +
{{ToReview}}
  
−
The method of interface of PDF-XChange Editor SDK.
+
The Returns the value of a specified element of an array as an unicode string ('''BSTR'''). If specified element type is not <code>PVT_String</code> <code>sDefVal</code> is returned.
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetString([in] ULONG nIndex, [in] BSTR pDefVal, [out, retval] BSTR* pVal);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Arr_GetString([in]           ULONG nIndex,
 +
                      [in]           BSTR   sDefVal,
 +
                      [out, retval] BSTR* sVal);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''nIndex''
+
;nIndex
−
:[in] Value of ULONG.
+
:[in] Specifies the index of the array element.
−
;''pDefVal''
+
;sDefVal
−
:[in] Value of BSTR.
+
:[in] Default value that will be returned when specified index is out of range or the element type is not <code>PVT_String</code>.
−
;''pVal''
+
;sVal
−
:[out, retval] Pointer to BSTR.
+
:[out, retval] Pointer to BSTR that receives the returned value.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
−
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Latest revision as of 02:42, 15 June 2015

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


The Returns the value of a specified element of an array as an unicode string (BSTR). If specified element type is not PVT_String sDefVal is returned.

Syntax

HRESULT Arr_GetString([in]           ULONG  nIndex,
                      [in]           BSTR   sDefVal,
                      [out, retval]  BSTR*  sVal);

Parameters

nIndex
[in] Specifies the index of the array element.
sDefVal
[in] Default value that will be returned when specified index is out of range or the element type is not PVT_String.
sVal
[out, retval] Pointer to BSTR that receives the returned value.

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_GetString&oldid=45363"