IPXC_Document::SetEncodersForStreamType Method
From PDF XChange PDF SDK
Line 3: | Line 3: | ||
{{#customTitle:IPXC_Document::SetEncodersForStreamType Method}} | {{#customTitle:IPXC_Document::SetEncodersForStreamType Method}} | ||
{{#parentPage:PXV:IPXC_Document#Methods|SetEncodersForStreamType|method}} | {{#parentPage:PXV:IPXC_Document#Methods|SetEncodersForStreamType|method}} | ||
− | |||
{{ToReview}} | {{ToReview}} | ||
− | + | Sets encoders for new streams. | |
== Syntax == | == Syntax == | ||
Line 16: | Line 15: | ||
:[in] Value of LPWSTR. | :[in] Value of LPWSTR. | ||
:Default encoders for stream type: | :Default encoders for stream type: | ||
− | :* '''"Image.TrueColor"''' | + | :* '''"Image.TrueColor"''' |
− | :* '''"Image.Gray"''' | + | :* '''"Image.Gray"''' |
− | :* '''"Image.Indexed"''' | + | :* '''"Image.Indexed"''' |
− | :* '''"Image.Monochrome"''' | + | :* '''"Image.Monochrome"''' |
− | :* '''"General"''' | + | :* '''"General"''' |
− | :* '''"Fonts"''' | + | :* '''"Fonts"''' |
− | :* '''"Page.Content"''' | + | :* '''"Page.Content"''' |
− | :* '''"Attachments"''' | + | :* '''"Attachments"''' |
;pArray | ;pArray | ||
− | :[in] Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]]. | + | :[in] Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]] containing the encode filters array. |
== Return Value == | == Return Value == |
Revision as of 01:53, 23 June 2016
Sets encoders for new streams.
Syntax
HRESULT SetEncodersForStreamType([in] LPWSTR sType, [in] IPXS_EncodeFiltersArray* pArray);
Parameters
- sType
- [in] Value of LPWSTR.
- Default encoders for stream type:
- "Image.TrueColor"
- "Image.Gray"
- "Image.Indexed"
- "Image.Monochrome"
- "General"
- "Fonts"
- "Page.Content"
- "Attachments"
- pArray
- [in] Pointer to IPXS_EncodeFiltersArray containing the encode filters array.
Return Value
Returns S_OK if operation was successful or error code in other cases.
Sample
//C# PDFXEdit.IPXS_EncodeFiltersArray arr = pxsInst.Create_EncodeFiltersArray(); arr.AddFilterInfo(pxsInst.StrToAtom("JBIG2Decode"), null); pdfCtl.Doc.CoreDoc.SetEncodersForStreamType("Image.TrueColor", arr);