IPXS_DecodeFilter::Name Property

From Tracker Software PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
Line 2: Line 2:
 
{{#customTitle:IPXS_DecodeFilter::Name Property}}
 
{{#customTitle:IPXS_DecodeFilter::Name Property}}
  
Property '''Name''' of interface [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]] returns  Value of ULONG ...
+
Returns an atom associated with ''PDF name'' of the filter. Some filters, like FlateDecode, may have two names and depends of '''bShort''' parameter different names are returned. For other type of filters this parameter would be ignored.
 
+
  
 
== Syntax ==
 
== Syntax ==
Line 11: Line 10:
 
== Parameters ==
 
== Parameters ==
 
;''bShort''
 
;''bShort''
:[in, optional] Value of VARIANT_BOOL.
+
:[in, optional] 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 ==
 
See also [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]].
 
See also [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]].

Revision as of 18:42, 29 March 2015

Returns an atom associated with PDF name of the filter. Some filters, like FlateDecode, may have two names and depends of bShort parameter different names are returned. For other type of filters this parameter would be ignored.

Syntax

HRESULT get_Name([in, optional] VARIANT_BOOL bShort, [out, retval] ULONG* pName);

Parameters

bShort
[in, optional] 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 IPXS_DecodeFilter.