TASKDIALOGCONFIG 结构 (commctrl.h)

TASKDIALOGCONFIG 结构包含用于显示任务对话框的信息。 TaskDialogIndirect 函数使用此结构。

语法

typedef struct _TASKDIALOGCONFIG {
  UINT                           cbSize;
  HWND                           hwndParent;
  HINSTANCE                      hInstance;
  TASKDIALOG_FLAGS               dwFlags;
  TASKDIALOG_COMMON_BUTTON_FLAGS dwCommonButtons;
  PCWSTR                         pszWindowTitle;
  union {
    HICON  hMainIcon;
    PCWSTR pszMainIcon;
  } DUMMYUNIONNAME;
  PCWSTR                         pszMainInstruction;
  PCWSTR                         pszContent;
  UINT                           cButtons;
  const TASKDIALOG_BUTTON        *pButtons;
  int                            nDefaultButton;
  UINT                           cRadioButtons;
  const TASKDIALOG_BUTTON        *pRadioButtons;
  int                            nDefaultRadioButton;
  PCWSTR                         pszVerificationText;
  PCWSTR                         pszExpandedInformation;
  PCWSTR                         pszExpandedControlText;
  PCWSTR                         pszCollapsedControlText;
  union {
    HICON  hFooterIcon;
    PCWSTR pszFooterIcon;
  } DUMMYUNIONNAME2;
  PCWSTR                         pszFooter;
  PFTASKDIALOGCALLBACK           pfCallback;
  LONG_PTR                       lpCallbackData;
  UINT                           cxWidth;
} TASKDIALOGCONFIG;

成员

cbSize

类型： UINT

指定结构大小（以字节为单位）。

hwndParent

类型： HWND

父窗口的句柄。 此成员可以为 NULL。

hInstance

类型： HINSTANCE

模块句柄，该模块包含 由 pszMainIcon 或 pszFooterIcon 成员标识的图标资源，以及由 pszWindowTitle、 pszMainInstruction、 pszContent、 pszVerificationText、 pszExpandedInformation、 pszExpandedControlText、 pszCollapsedControlText 或 pszFooter 成员标识的字符串资源。

dwFlags

类型： TASKDIALOG_FLAGS

指定任务对话框的行为。 此参数可以是以下组中标志的组合：

<A HREF="executablestring">Hyperlink Text</A>

dwCommonButtons

类型： TASKDIALOG_COMMON_BUTTON_FLAGS

指定任务对话框中显示的按钮。 如果未指定常用按钮，并且未使用 cButtons 和 pButtons 成员指定自定义按钮，则任务对话框将默认包含 “确定” 按钮。 此参数可以是以下组中标志的组合：

pszWindowTitle

类型： PCWSTR

引用要用于任务对话框标题的字符串的指针。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。 如果此参数为 NULL，则使用可执行程序的文件名。

DUMMYUNIONNAME

DUMMYUNIONNAME.hMainIcon

类型： HICON

将在任务对话框中显示的图标的句柄。 除非指定了TDF_USE_HICON_MAIN标志，否则将忽略此成员。 如果此成员为 NULL 并且指定了TDF_USE_HICON_MAIN，则不会显示任何图标。

DUMMYUNIONNAME.pszMainIcon

类型： PCWSTR

引用要显示在任务对话框中的图标的指针。 如果指定了USE_HICON_MAIN标志，则忽略此参数。 否则，如果此参数为 NULL 或 hInstance 参数为 NULL，则不会显示任何图标。 此参数必须是传递给 MAKEINTRESOURCE 宏的整数资源标识符或以下预定义值之一：

pszMainInstruction

类型： PCWSTR

引用要用于main指令的字符串的指针。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。

pszContent

类型： PCWSTR

引用要用于对话的主要内容的字符串的指针。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。 如果为 dwFlags 成员指定了ENABLE_HYPERLINKS标志，则此字符串可能包含以下形式的超链接： <A HREF=“executablestring”>Hyperlink Text</A>。 警告：使用来自不安全源的内容时启用超链接可能会导致安全漏洞。

cButtons

类型： UINT

pButtons 数组中用于在任务对话框中创建按钮或命令链接的条目数。 如果此成员为零，并且未使用 dwCommonButtons 成员指定公共按钮，则任务对话框将显示一个 “确定” 按钮。

pButtons

类型： const TASKDIALOG_BUTTON*

指向 TASKDIALOG_BUTTON 结构的数组的指针，其中包含要显示在任务对话框中的自定义按钮的定义。 此数组必须至少包含 cButtons 成员指定的条目数。

nDefaultButton

类型： int

任务对话框的默认按钮。 这可以是 pButtons 数组中TASKDIALOG_BUTTON结构之一的 nButtonID 成员中指定的任何值，也可以是与 dwCommonButtons 成员中指定的按钮对应的 ID 之一：

如果此成员为零或其值与对话框中的任何按钮 ID 不对应，则对话框中的第一个按钮将是默认值。

cRadioButtons

类型： UINT

pRadioButtons 数组中用于在任务对话框中创建单选按钮的条目数。

pRadioButtons

类型： const TASKDIALOG_BUTTON*

指向 TASKDIALOG_BUTTON 结构的数组的指针，其中包含要显示在任务对话框中的单选按钮的定义。 此数组必须至少包含 cRadioButtons 成员指定的条目数。 此参数可以为 NULL。

nDefaultRadioButton

类型： int

默认选择的单选按钮的按钮 ID。 如果此值与按钮 ID 不对应，则默认情况下会选择数组中的第一个按钮。

pszVerificationText

类型： PCWSTR

引用用于标记验证复选框的字符串的指针。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。 如果此参数为 NULL，则任务对话框中不会显示验证复选框。 如果 TaskDialogIndirect 的 pfVerificationFlagChecked 参数为 NULL，则不启用该复选框。

pszExpandedInformation

类型： PCWSTR

引用要用于显示其他信息的字符串的指针。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。 附加信息显示在内容下方或页脚文本下方，具体取决于是否指定了TDF_EXPAND_FOOTER_AREA标志。 如果为 dwFlags 成员指定了 TDF_ENABLE_HYPERLINKS 标志，则此字符串可能包含以下形式的超链接： <A HREF=“executablestring”>Hyperlink Text</A>。 警告：使用来自不安全源的内容时启用超链接可能会导致安全漏洞。

pszExpandedControlText

类型： PCWSTR

引用字符串的指针，该字符串用于标记折叠可展开信息的按钮。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。 当 pszExpandedInformation 成员为 NULL 时，将忽略此成员。 如果此成员为 NULL 并且指定 了 pszCollapsedControlText ，则 pszCollapsedControlText 值也将用于此成员。

pszCollapsedControlText

类型： PCWSTR

引用字符串的指针，该字符串用于标记按钮以展开可展开的信息。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。 当 pszExpandedInformation 成员为 NULL 时，将忽略此成员。 如果此成员为 NULL 并且指定 了 pszCollapsedControlText ，则 pszCollapsedControlText 值也将用于此成员。

DUMMYUNIONNAME2

DUMMYUNIONNAME2.hFooterIcon

类型： HICON

将在任务对话框的页脚中显示的图标的句柄。 除非指定了 TDF_USE_HICON_FOOTER 标志，但 pszFooterIcon 未指定，否则将忽略此成员。 如果此成员为 NULL 并且指定了TDF_USE_HICON_FOOTER，则不显示任何图标。

DUMMYUNIONNAME2.pszFooterIcon

类型： PCWSTR

引用要显示在任务对话框的页脚区域中的图标的指针。 如果指定了TDF_USE_HICON_FOOTER标志，或者 pszFooter 为 NULL，则忽略此参数。 否则，如果此参数为 NULL 或 hInstance 参数为 NULL，则不显示图标。 此参数必须是传递给 MAKEINTRESOURCE 宏的整数资源标识符或 为 pszMainIcon 列出的预定义值之一。

pszFooter

类型： PCWSTR

指向要用于任务对话框页脚区域的字符串的指针。 此参数可以是以 null 结尾的字符串，也可以是传递给 MAKEINTRESOURCE 宏的整数资源标识符。 如果为 dwFlags 成员指定了TDF_ENABLE_HYPERLINKS标志，则此字符串可能包含此格式的超链接。

<A HREF="executablestring">Hyperlink Text</A>

pfCallback

类型： PFTASKDIALOGCALLBACK

指向应用程序定义的回调函数的指针。 有关详细信息，请参阅 TaskDialogCallbackProc。

lpCallbackData

类型： LONG_PTR

指向应用程序定义的引用数据的指针。 此值由调用方定义。

cxWidth

类型： UINT

任务对话框工作区的宽度（以对话单元为单位）。 如果为 0，则任务对话框管理器将计算理想宽度。

要求