IPXS_PDFVariant::Stream_CreateEncoder Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Stream_CreateEncoder Method}}
 
{{#customTitle:IPXS_PDFVariant::Stream_CreateEncoder Method}}
{{#parentPage:PXV:IPXS_PDFVariant|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant|Stream_CreateEncoder Method|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 8: Line 8:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Stream_CreateEncoder([in] IPXS_EncodeFiltersArray* pFilters, [in, defaultvalue(NULL)] PXS_StreamInfo* pStreamInfo, [in, defaultvalue(0)] ULONG dwFlags, [out, retval] IPXS_EncodeFilter** ppEncoder);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Stream_CreateEncoder([in]                     IPXS_EncodeFiltersArray* pFilters,
 +
                            [in, defaultvalue(NULL)] PXS_StreamInfo*           pStreamInfo,
 +
                            [in, defaultvalue(0)]     ULONG                     dwFlags,
 +
                            [out, retval]             IPXS_EncodeFilter**       ppEncoder);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pFilters''
+
;pFilters
 
:[in]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]].
 
:[in]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]].
;''pStreamInfo''
+
;pStreamInfo
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
;''dwFlags''
+
;dwFlags
 
:[in, defaultvalue(0)]  Value of ULONG.
 
:[in, defaultvalue(0)]  Value of ULONG.
;''ppEncoder''
+
;ppEncoder
 
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFilter|IPXS_EncodeFilter]].
 
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFilter|IPXS_EncodeFilter]].
  

Revision as of 06:18, 23 April 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Stream_CreateEncoder([in]                      IPXS_EncodeFiltersArray*  pFilters,
                             [in, defaultvalue(NULL)]  PXS_StreamInfo*           pStreamInfo,
                             [in, defaultvalue(0)]     ULONG                     dwFlags,
                             [out, retval]             IPXS_EncodeFilter**       ppEncoder);

Parameters

pFilters
[in] Pointer to IPXS_EncodeFiltersArray.
pStreamInfo
[in, defaultvalue(NULL)] Pointer to PXS_StreamInfo.
dwFlags
[in, defaultvalue(0)] Value of ULONG.
ppEncoder
[out, retval] Pointer to IPXS_EncodeFilter.

Return Value

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

See Also

See also IPXS_PDFVariant.