IPropertyDescription::GetTypeFlags method (propsys.h)

Gets a set of flags that describe the uses and capabilities of the property.

Syntax

HRESULT GetTypeFlags(
  [in]  PROPDESC_TYPE_FLAGS mask,
  [out] PROPDESC_TYPE_FLAGS *ppdtFlags
);

Parameters

[in] mask

Type: PROPDESC_TYPE_FLAGS

A mask that specifies which type flags to retrieve. A combination of values found in the PROPDESC_TYPE_FLAGS constants. To retrieve all type flags, pass PDTF_MASK_ALL

[out] ppdtFlags

Type: PROPDESC_TYPE_FLAGS*

When this method returns, contains a pointer to a value that consists of bitwise PROPDESC_TYPE_FLAGS values.

Return value

Type: HRESULT

Always returns S_OK.

Remarks

If the property description instance comes from PSGetPropertyDescription or PSGetPropertyDescriptionByName, these flags come from the .propdesc file that defines the property description.

If the instance comes from GetAt, the type flags come from the .propdesc file and may be influenced by the specific proplist. This means that flags obtained from one property description instance may be slightly different from another instance (both referring to the same property).

For additional information on type flags, see the canGroupBy, canStackBy, isInnate, multipleValues, isGroup, isTreeProperty, isViewable, isQueryable, and includeInFullTextQuery attributes of the typeInfo element in the property's .propdesc file.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header propsys.h

See also

IPropertyDescription

Property Description Schema