Share via


TDM_UPDATE_ICON (Compact 2013)

3/28/2014

This message refreshes a task dialog's icon.

Syntax

TDM_UPDATE_ICON
    wParam = 0;
    lParam = (LPARAM) (PCWSTR) pszIcon;

Parameters

  • wParam
    Not used.
  • pszIcon
    Pointer to a string (PCWSTR) or handle to an icon (HICON) to display in the task dialog.

    If you set the TDF_USE_HICON_MAIN flag in the dwFlags member of the TASKDIALOGCONFIG structure used to create the task dialog, then this parameter must contain a handle to an icon (HICON) to display.

    If you do not set the TDF_USE_HICON_MAIN flags, then this parameter must point to a null-terminated, Unicode string (PCWSTR) that contains a valid resource identifier passed through the MAKEINTRESOURCE macro. The resource must be either from the application's resource module (specified in the hInstance member of TASKDIALOGCONFIG), or, if hInstance is NULL, from the system's resource module (imageres.dll). The resource can also be one of the following predefined icons:

    • TD_WARNING_ICON
      An exclamation point icon.
    • TD_ERROR_ICON
      A stop sign icon.
    • TD_INFORMATION_ICON
      A icon consisting of a lowercase letter 'i' in a circle.
    • TD_SHIELD_ICON
      A shield icon.
    • TD_CONFIRMATION_ICON
      A confirmation icon.

    This parameter is ignored if you specify USE_HICON_MAIN (from TASKDIALOG_FLAGS). Otherwise, if this parameter is NULL or hInstance is NULL, no icon is displayed.

Return Value

The return value is ignored.

Remarks

An application window receives this message through its WindowProc function.

Requirements

Header

shellctrls.h

See Also

Reference

Task Dialogs Messages
TASKDIALOGCONFIG
TASKDIALOG_FLAGS
MAKEINTRESOURCE