IPXS_PDFVariant::Stream_CreateEncoder 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_CreateEncoder Method}}
 
{{#customTitle:IPXS_PDFVariant::Stream_CreateEncoder Method}}
 +
{{#parentPage:PXV:IPXS_PDFVariant#Methods|Stream_CreateEncoder|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_CreateEncoder([in] IPXS_EncodeFiltersArray* pFilters, [in, optional] PXS_StreamInfo* pStreamInfo, [in, optional] 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*           stStreamInfo,
 +
                            [in, defaultvalue(0)]     ULONG                     nFlags,
 +
                            [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, optional]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
−
;''dwFlags''
+
;nFlags
−
:[in, optional]  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 21: Line 28:
  
 
== 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_CreateEncoder Method


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

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXS_PDFVariant_Stream_CreateEncoder&oldid=45462"