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)
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_PDFVariant::Stream_CreateEncoder Method}}
 
{{#customTitle:IPXS_PDFVariant::Stream_CreateEncoder Method}}
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Stream_CreateEncoder Method|method}}
+
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Stream_CreateEncoder|method}}
 
{{ToWrite}}
 
{{ToWrite}}
 
{{ToReview}}
 
{{ToReview}}
Line 10: Line 10:
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT Stream_CreateEncoder([in]                      IPXS_EncodeFiltersArray*  pFilters,
 
<pre class="brush:cpp;gutter:false">HRESULT Stream_CreateEncoder([in]                      IPXS_EncodeFiltersArray*  pFilters,
                             [in, defaultvalue(NULL)]  PXS_StreamInfo*          pStreamInfo,
+
                             [in, defaultvalue(NULL)]  PXS_StreamInfo*          stStreamInfo,
                             [in, defaultvalue(0)]    ULONG                    dwFlags,
+
                             [in, defaultvalue(0)]    ULONG                    nFlags,
                             [out, retval]            IPXS_EncodeFilter**      ppEncoder);</pre>
+
                             [out, retval]            IPXS_EncodeFilter**      pEncoder);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;pFilters
 
;pFilters
 
:[in]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]].
 
:[in]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]].
;pStreamInfo
+
;stStreamInfo
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
;dwFlags
+
;nFlags
 
:[in, defaultvalue(0)]  Value of ULONG.
 
:[in, defaultvalue(0)]  Value of ULONG.
;ppEncoder
+
;pEncoder
 
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFilter|IPXS_EncodeFilter]].
 
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFilter|IPXS_EncodeFilter]].
  
Line 28: Line 28:
  
 
== 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_CreateEncoder([in]                      IPXS_EncodeFiltersArray*  pFilters,
                             [in, defaultvalue(NULL)]  PXS_StreamInfo*           stStreamInfo,
                             [in, defaultvalue(0)]     ULONG                     nFlags,
                             [out, retval]             IPXS_EncodeFilter**       pEncoder);

Parameters

pFilters
[in] Pointer to IPXS_EncodeFiltersArray.
stStreamInfo
[in, defaultvalue(NULL)] Pointer to PXS_StreamInfo.
nFlags
[in, defaultvalue(0)] Value of ULONG.
pEncoder
[out, retval] Pointer to IPXS_EncodeFilter.

Return Value

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

See Also

IPXS_PDFVariant