IPXS_PDFVariant::Stream_GetData 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 the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Stream_GetData Method}}
 
{{#customTitle:IPXS_PDFVariant::Stream_GetData Method}}
 +
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Stream_GetData|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Stream_GetData([in] IStream* pDest, [in, optional] StreamDecodeDepth nDepth);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Stream_GetData([in]                                 IStream*               pDest,
 +
                      [in, defaultvalue(DecodeDepth_All)] PXS_StreamDecodeDepth  nDepth,
 +
                      [in, defaultvalue(-1)]              VARIANT_BOOL          bConvertCbCr);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pDest''
+
;pDest
 
:[in]  Pointer to IStream.
 
:[in]  Pointer to IStream.
;''nDepth''
+
;nDepth
:[in, optional]  Value of [[PXV:StreamDecodeDepth|StreamDecodeDepth]].
+
:[in, defaultvalue(DecodeDepth_All)]  Value of [[PXV:PXS_StreamDecodeDepth|PXS_StreamDecodeDepth]].
 +
;bConvertCbCr
 +
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 25:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
[[PXV:IPXS_PDFVariant|IPXS_PDFVariant]]

Latest revision as of 03:45, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Stream_GetData([in]                                 IStream*               pDest,
                       [in, defaultvalue(DecodeDepth_All)]  PXS_StreamDecodeDepth  nDepth,
                       [in, defaultvalue(-1)]               VARIANT_BOOL           bConvertCbCr);

Parameters

pDest
[in] Pointer to IStream.
nDepth
[in, defaultvalue(DecodeDepth_All)] Value of PXS_StreamDecodeDepth.
bConvertCbCr
[in, defaultvalue(-1)] Value of VARIANT_BOOL.

Return Value

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

See Also

IPXS_PDFVariant