IPXC_Document::GetEncodersForStreamType Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Reverted edits by Dsbot (talk) to last revision by Oliynykd)
 
(3 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
{{#customTitle:IPXC_Document::GetEncodersForStreamType Method}}
 
{{#customTitle:IPXC_Document::GetEncodersForStreamType Method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|GetEncodersForStreamType|method}}
 
{{#parentPage:PXV:IPXC_Document#Methods|GetEncodersForStreamType|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets encoders for current document.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
;sType
 
;sType
 
:[in]  Value of LPWSTR.
 
:[in]  Value of LPWSTR.
 +
:Default encoders for stream type:
 +
:* '''"Image.TrueColor"'''
 +
:* '''"Image.Gray"'''
 +
:* '''"Image.Indexed"'''
 +
:* '''"Image.Monochrome"'''
 +
:* '''"General"'''
 +
:* '''"Fonts"'''
 +
:* '''"Page.Content"'''
 +
:* '''"Attachments"'''
 
;pFilters
 
;pFilters
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]].
+
:[out, retval]  Pointer to [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]] containing the encode filters array.
  
 
== Return Value ==
 
== Return Value ==
 
Returns S_OK if operation was successful or error code in other cases.
 
Returns S_OK if operation was successful or error code in other cases.
 +
 +
<pre class="brush:c#">//C#
 +
string str = "";
 +
PDFXEdit.IPXS_EncodeFiltersArray arrDef = pdfCtl.Doc.CoreDoc.GetEncodersForStreamType("Image.TrueColor");
 +
for (uint i = 0; i< arrDef.Count; i++)
 +
{
 +
uint atomId = arrDef.FilterName[i];
 +
str += pxsInst.AtomToStr(atomId) + "\n";
 +
}
 +
MessageBox.Show(str);
 +
</pre>
  
 
== See Also ==
 
== See Also ==
[[PXV:IPXC_Document|IPXC_Document]]
+
[[PXV:IPXC_Document|IPXC_Document]], [[PXV:IPXC_Document_SetEncodersForStreamType|IPXC_Document::SetEncodersForStreamType]], [[PXV:IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]]

Latest revision as of 00:11, 1 December 2017


Gets encoders for current document.

Syntax

HRESULT GetEncodersForStreamType([in]           LPWSTR                     sType,
                                 [out, retval]  IPXS_EncodeFiltersArray**  pFilters);

Parameters

sType
[in] Value of LPWSTR.
Default encoders for stream type:
  • "Image.TrueColor"
  • "Image.Gray"
  • "Image.Indexed"
  • "Image.Monochrome"
  • "General"
  • "Fonts"
  • "Page.Content"
  • "Attachments"
pFilters
[out, retval] Pointer to IPXS_EncodeFiltersArray containing the encode filters array.

Return Value

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

//C#
string str = "";
PDFXEdit.IPXS_EncodeFiltersArray arrDef = pdfCtl.Doc.CoreDoc.GetEncodersForStreamType("Image.TrueColor");
for (uint i = 0; i< arrDef.Count; i++)
{
	uint atomId = arrDef.FilterName[i];
	str += pxsInst.AtomToStr(atomId) + "\n";
}
MessageBox.Show(str);

See Also

IPXC_Document, IPXC_Document::SetEncodersForStreamType, IPXS_EncodeFiltersArray