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)
Line 5: Line 5:
  
 
== 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)] 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:StreamDecodeDepth|StreamDecodeDepth]].
 
;''pFilter''
 
;''pFilter''
 
:[out, retval]  Pointer to [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]].
 
:[out, retval]  Pointer to [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]].

Revision as of 00:29, 17 April 2015

The method of interface of PDF-XChange Editor SDK.

Syntax

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

Parameters

nFlags
[in, defaultvalue(0)] Value of ULONG.
nDepth
[in, defaultvalue(DecodeDepth_All)] Value of 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

See also IPXS_PDFVariant.