IPXS_DecodeFilter::Name Property

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXS_DecodeFilter::Name Property}}
 
{{#customTitle:IPXS_DecodeFilter::Name Property}}
 +
{{#parentPage:PXV:IPXS_DecodeFilter#Properties|Name|property}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
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.
 
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 ==
<pre class="brush:cpp;gutter:false">HRESULT get_Name([in, defaultvalue(0)] VARIANT_BOOL bShort, [out, retval] ULONG* pName);
+
<pre class="brush:cpp;gutter:false">HRESULT get_Name([in, defaultvalue(0)] VARIANT_BOOL bShort,
 +
                [out, retval]         ULONG*       nName);
 
</pre>
 
</pre>
  
 
== Parameters ==
 
== Parameters ==
;''bShort''
+
;bShort
 
:[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 ==
See also [[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]].
+
[[PXV:IPXS_DecodeFilter|IPXS_DecodeFilter]]

Latest revision as of 03:40, 15 June 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, defaultvalue(0)]  VARIANT_BOOL  bShort,
                 [out, retval]          ULONG*        nName);

Parameters

bShort
[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

IPXS_DecodeFilter