Edit

Share via

ListView_GetEmptyText macro (commctrl.h)

  • Article
  • 2024/10/23

Gets the text meant for display when the list-view control appears empty. Use this macro or send the LVM_GETEMPTYTEXT message explicitly.

Syntax

BOOL ListView_GetEmptyText(
  [in]      HWND  hwnd,
  [in, out] PWSTR pszText,
  [in]      UINT  cchText
);

Parameters

[in] hwnd

Type: HWND

A handle to the list-view control.

[in, out] pszText

Type: PWSTR

A pointer to a null-terminated, Unicode buffer of size specified by cchText to receive the text. The caller is responsible for allocating the buffer.

[in] cchText

Type: UINT

The size of the buffer pointed to by pszText, including the terminating NULL.

Return value

Type: BOOL

Returns TRUE if successful, or FALSE otherwise.

Requirements

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