IPropertyUI::FormatForDisplay method (shobjidl_core.h)

Developers should use IPropertyDescription instead. Gets a formatted, Unicode string representation of a property value.

Syntax

HRESULT FormatForDisplay(
  [in]  REFFMTID                fmtid,
  [in]  PROPID                  pid,
  [in]  const PROPVARIANT       *ppropvar,
  [in]  PROPERTYUI_FORMAT_FLAGS puiff,
  [out] LPWSTR                  pwszText,
  [in]  DWORD                   cchText
);

Parameters

[in] fmtid

Type: REFFMTID

[in] pid

Type: PROPID

[in] ppropvar

Type: PROPVARIANT*

A PROPVARIANT structure that contains the type and value of the property.

[in] puiff

Type: PROPERTYUI_FORMAT_FLAGS

The format for the returned property value.

PUIFFDF_DEFAULT (0x00000000)

0x00000000.

PUIFFDF_RIGHTTOLEFT (0x00000001)

0x00000001. Deprecated, do not use.

PUIFFDF_SHORTFORMAT (0x00000002)

0x00000002. Use the short format version of the string.

PUIFFDF_NOTIME (0x00000004)

0x00000004. Truncate time to days, not hours/mins/sec.

PUIFFDF_FRIENDLYDATE (0x00000008)

0x00000008. Use the friendly name for date: "Today", "Yesterday", and so on.

[out] pwszText

Type: LPWSTR

The property value, formatted for display.

[in] cchText

Type: DWORD

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h