IPXS_PDFVariant::Stream_CreateDecoder Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Stream_CreateDecoder Method}}
 
{{#customTitle:IPXS_PDFVariant::Stream_CreateDecoder Method}}
 +
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Stream_CreateDecoder|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_CreateDecoder([in, optional] ULONG nFlags, [in, optional] StreamDecodeDepth nDepth, [out, retval] IPXS_DecodeFilter** pFilter);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Stream_CreateDecoder([in, defaultvalue(0)]               ULONG                 nFlags,
 +
                            [in, defaultvalue(DecodeDepth_All)] PXS_StreamDecodeDepth  nDepth,
 +
                            [out, retval]                       IPXS_DecodeFilter**   pFilter);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;''nFlags''
+
;nFlags
−
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
−
;''nDepth''
+
;nDepth
−
:[in, optional]  Value of [[PXV:StreamDecodeDepth|StreamDecodeDepth]].
+
:[in, defaultvalue(DecodeDepth_All)]  Value of [[PXV:PXS_StreamDecodeDepth|PXS_StreamDecodeDepth]].
−
;''pFilter''
+
;pFilter
 
:[out, retval]  Pointer to [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]].
 
:[out, retval]  Pointer to [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]].
  
Line 19: 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

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


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Stream_CreateDecoder([in, defaultvalue(0)]                ULONG                  nFlags,
                             [in, defaultvalue(DecodeDepth_All)]  PXS_StreamDecodeDepth  nDepth,
                             [out, retval]                        IPXS_DecodeFilter**    pFilter);

Parameters

nFlags
[in, defaultvalue(0)] Value of ULONG.
nDepth
[in, defaultvalue(DecodeDepth_All)] Value of PXS_StreamDecodeDepth.
pFilter
[out, retval] Pointer to IPXS_DecodeFilter.

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_Stream_CreateDecoder&oldid=45461"