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 9: Line 9:
  
 
== 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*  Filters,
−
                             [in, defaultvalue(NULL)]  PXS_StreamInfo*          stStreamInfo,
+
                             [in, defaultvalue(NULL)]  PXS_StreamInfo*          StreamInfo,
−
                             [in, defaultvalue(0)]    ULONG                    nFlags,
+
                             [in, defaultvalue(0)]    ULONG                    Flags,
−
                             [out, retval]            IPXS_EncodeFilter**      pEncoder);</pre>
+
                             [out, retval]            IPXS_EncodeFilter**      Encoder);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;pFilters
+
;Filters
 
:[in]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]].
 
:[in]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]].
−
;stStreamInfo
+
;StreamInfo
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:PXS_StreamInfo|PXS_StreamInfo]].
−
;nFlags
+
;Flags
 
:[in, defaultvalue(0)]  Value of ULONG.
 
:[in, defaultvalue(0)]  Value of ULONG.
−
;pEncoder
+
;Encoder
 
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFilter|IPXS_EncodeFilter]].
 
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFilter|IPXS_EncodeFilter]].
  

Revision as of 07:21, 12 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*  Filters,
                             [in, defaultvalue(NULL)]  PXS_StreamInfo*           StreamInfo,
                             [in, defaultvalue(0)]     ULONG                     Flags,
                             [out, retval]             IPXS_EncodeFilter**       Encoder);

Parameters

Filters
[in] Pointer to IPXS_EncodeFiltersArray.
StreamInfo
[in, defaultvalue(NULL)] Pointer to PXS_StreamInfo.
Flags
[in, defaultvalue(0)] Value of ULONG.
Encoder
[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=43090"