IPXS_Document::GetStandardStreamEncoder Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXS_Document::GetStandardStreamEncoder Method}} | {{#customTitle:IPXS_Document::GetStandardStreamEncoder Method}} | ||
+ | {{#parentPage:PXV:IPXS_Document#Methods|GetStandardStreamEncoder|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 GetStandardStreamEncoder([in] PXS_StreamEncoderParamStruct* Params, [in] ULONG nKeyLen, [in] UCHAR* pKey, [in] ULONG nVersion, [in] ULONG nRevision, [in] | + | <pre class="brush:cpp;gutter:false">HRESULT GetStandardStreamEncoder([in] PXS_StreamEncoderParamStruct* Params, |
+ | [in] ULONG nKeyLen, | ||
+ | [in] UCHAR* pKey, | ||
+ | [in] ULONG nVersion, | ||
+ | [in] ULONG nRevision, | ||
+ | [in] PXS_CryptMethod nMethod, | ||
+ | [in] VARIANT_BOOL bEncodeMetadata, | ||
+ | [in] VARIANT_BOOL bOnlyEF, | ||
+ | [out, retval] IPXS_pdfStreamCoder** pDecoder);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;Params |
:[in] Pointer to [[PXV:PXS_StreamEncoderParamStruct|PXS_StreamEncoderParamStruct]]. | :[in] Pointer to [[PXV:PXS_StreamEncoderParamStruct|PXS_StreamEncoderParamStruct]]. | ||
− | ; | + | ;nKeyLen |
:[in] Value of ULONG. | :[in] Value of ULONG. | ||
− | ; | + | ;pKey |
:[in] Pointer to UCHAR. | :[in] Pointer to UCHAR. | ||
− | ; | + | ;nVersion |
:[in] Value of ULONG. | :[in] Value of ULONG. | ||
− | ; | + | ;nRevision |
:[in] Value of ULONG. | :[in] Value of ULONG. | ||
− | ; | + | ;nMethod |
− | :[in] Value of | + | :[in] Value of [[PXV:PXS_CryptMethod|PXS_CryptMethod]]. |
− | ; | + | ;bEncodeMetadata |
:[in] Value of VARIANT_BOOL. | :[in] Value of VARIANT_BOOL. | ||
− | ; | + | ;bOnlyEF |
:[in] Value of VARIANT_BOOL. | :[in] Value of VARIANT_BOOL. | ||
− | ; | + | ;pDecoder |
:[out, retval] Pointer to [[PXV:IPXS_pdfStreamCoder|IPXS_pdfStreamCoder]]. | :[out, retval] Pointer to [[PXV:IPXS_pdfStreamCoder|IPXS_pdfStreamCoder]]. | ||
Line 31: | Line 43: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IPXS_Document|IPXS_Document]] |
Latest revision as of 23:41, 22 May 2015
The method of interface of PDF-XChange Editor SDK.
Syntax
HRESULT GetStandardStreamEncoder([in] PXS_StreamEncoderParamStruct* Params, [in] ULONG nKeyLen, [in] UCHAR* pKey, [in] ULONG nVersion, [in] ULONG nRevision, [in] PXS_CryptMethod nMethod, [in] VARIANT_BOOL bEncodeMetadata, [in] VARIANT_BOOL bOnlyEF, [out, retval] IPXS_pdfStreamCoder** pDecoder);
Parameters
- Params
- [in] Pointer to PXS_StreamEncoderParamStruct.
- nKeyLen
- [in] Value of ULONG.
- pKey
- [in] Pointer to UCHAR.
- nVersion
- [in] Value of ULONG.
- nRevision
- [in] Value of ULONG.
- nMethod
- [in] Value of PXS_CryptMethod.
- bEncodeMetadata
- [in] Value of VARIANT_BOOL.
- bOnlyEF
- [in] Value of VARIANT_BOOL.
- pDecoder
- [out, retval] Pointer to IPXS_pdfStreamCoder.
Return Value
Returns S_OK if operation was successful or error code in other cases.