IPXS_DecodeFilter::Name Property
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
Line 6: | Line 6: | ||
{{ToReview}} | {{ToReview}} | ||
− | Returns an atom associated with ''PDF name'' of the filter. Some filters, like FlateDecode, may have two names and depends of ''' | + | Returns an atom associated with ''PDF name'' of the filter. Some filters, like FlateDecode, may have two names and depends of '''Short''' parameter different names are returned. For other type of filters this parameter would be ignored. |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT get_Name([in, defaultvalue(0)] VARIANT_BOOL | + | <pre class="brush:cpp;gutter:false">HRESULT get_Name([in, defaultvalue(0)] VARIANT_BOOL Short, |
− | [out, retval] ULONG* | + | [out, retval] ULONG* Name); |
</pre> | </pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;Short |
:[in, defaultvalue(0)] Specifies which variant of the filter should be returned - long or short. For example, for FlateDecode filter, long name is '''FlateDecode''' and short name - '''Fl'''. | :[in, defaultvalue(0)] Specifies which variant of the filter should be returned - long or short. For example, for FlateDecode filter, long name is '''FlateDecode''' and short name - '''Fl'''. | ||
== See Also == | == See Also == | ||
[[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]] | [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]] |
Revision as of 07:16, 12 June 2015
Returns an atom associated with PDF name of the filter. Some filters, like FlateDecode, may have two names and depends of Short parameter different names are returned. For other type of filters this parameter would be ignored.
Syntax
HRESULT get_Name([in, defaultvalue(0)] VARIANT_BOOL Short, [out, retval] ULONG* Name);
Parameters
- Short
- [in, defaultvalue(0)] Specifies which variant of the filter should be returned - long or short. For example, for FlateDecode filter, long name is FlateDecode and short name - Fl.