TASKDIALOGCONFIG-Struktur (commctrl.h)

Artikel
08/22/2023

Die TASKDIALOGCONFIG-Struktur enthält Informationen, die zum Anzeigen eines Aufgabendialogfelds verwendet werden. Die TaskDialogIndirect-Funktion verwendet diese Struktur.

Syntax

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;

Member

cbSize

Typ: UINT

Gibt die Strukturgröße in Bytes an.

hwndParent

Typ: HWND

Handle für das übergeordnete Fenster. Dieses Element kann NULL sein.

hInstance

Typ: HINSTANCE

Handle mit dem Modul, das die Symbolressource enthält, die von den Membern pszMainIcon oder pszFooterIcon identifiziert wurde, und die Zeichenfolgenressourcen, die durch die Member pszWindowTitle, pszMainInstruction, pszContent, pszVerificationText, pszExpandedInformation, pszExpandedControlText, pszCollapsedControlText oder pszFooter identifiziert wurden.

dwFlags

Typ: TASKDIALOG_FLAGS

Gibt das Verhalten des Aufgabendialogfelds an. Dieser Parameter kann eine Kombination von Flags aus der folgenden Gruppe sein:

Wert	Bedeutung
TDF_ENABLE_HYPERLINKS	Aktiviert die Linkverarbeitung für die Zeichenfolgen, die in den Membern pszContent, pszExpandedInformation und pszFooter angegeben sind. Wenn diese Elemente aktiviert sind, verweisen diese Elemente möglicherweise auf Zeichenfolgen, die Links in der folgenden Form enthalten: `<A HREF="executablestring">Hyperlink Text</A>` Warnung: Das Aktivieren von Hyperlinks bei der Verwendung von Inhalten aus einer unsicheren Quelle kann zu Sicherheitsrisiken führen. Hinweis Aufgabendialoge führen keine Hyperlinks aus. Die Hyperlinkausführung muss in der von pfCallback angegebenen Rückruffunktion behandelt werden. Weitere Informationen finden Sie unter TaskDialogCallbackProc.
TDF_USE_HICON_MAIN	Gibt an, dass das Dialogfeld das Symbol verwenden soll, auf das vom Handle im hMainIcon-Member verwiesen wird, als primäres Symbol im Aufgabendialogfeld. Wenn dieses Flag angegeben wird, wird das pszMainIcon-Element ignoriert.
TDF_USE_HICON_FOOTER	Gibt an, dass das Dialogfeld das Symbol verwenden soll, auf das vom Handle im hFooterIcon-Element verwiesen wird, als Fußzeilensymbol im Aufgabendialogfeld. Wenn dieses Flag angegeben wird, wird das pszFooterIcon-Element ignoriert.
TDF_ALLOW_DIALOG_CANCELLATION	Gibt an, dass das Dialogfeld mit ALT-F4, Escape und der Schließen-Schaltfläche der Titelleiste geschlossen werden kann, auch wenn keine Abbrechen-Schaltfläche in den dwCommonButtons - oder pButtons-Membern angegeben ist.
TDF_USE_COMMAND_LINKS	Gibt an, dass die im pButtons-Element angegebenen Schaltflächen als Befehlslinks (mithilfe einer Standard-Aufgabendialogfeld-Glyphe) anstelle von Drucktasten angezeigt werden sollen. Wenn Sie Befehlslinks verwenden, werden alle Zeichen bis zum ersten neuen Zeilenzeichen im Element pszButtonText als Standard Text des Befehlslinks behandelt, und der Rest wird als Notiz des Befehlslinks behandelt. Dieses Flag wird ignoriert, wenn das cButtons-Element 0 ist.
TDF_USE_COMMAND_LINKS_NO_ICON	Gibt an, dass die im pButtons-Element angegebenen Schaltflächen als Befehlslinks (ohne Glyphe) anstelle von Drucktasten angezeigt werden sollen. Wenn Sie Befehlslinks verwenden, werden alle Zeichen bis zum ersten neuen Zeilenzeichen im Element pszButtonText als Standard Text des Befehlslinks behandelt, und der Rest wird als Notiz des Befehlslinks behandelt. Dieses Flag wird ignoriert, wenn das cButtons-Element 0 ist.
TDF_EXPAND_FOOTER_AREA	Gibt an, dass die vom Element pszExpandedInformation angegebene Zeichenfolge am unteren Rand des Fußzeilenbereichs des Dialogfelds angezeigt wird und nicht unmittelbar nach dem Inhalt des Dialogfelds. Dieses Flag wird ignoriert, wenn das Element pszExpandedInformationNULL ist.
TDF_EXPANDED_BY_DEFAULT	Gibt an, dass die vom element pszExpandedInformation angegebene Zeichenfolge angezeigt wird, wenn das Dialogfeld anfänglich angezeigt wird. Dieses Flag wird ignoriert, wenn das Element pszExpandedInformationNULL ist.
TDF_VERIFICATION_FLAG_CHECKED	Gibt an, dass das Überprüfungskontrollkästchen im Dialogfeld aktiviert ist, wenn das Dialogfeld anfänglich angezeigt wird. Dieses Flag wird ignoriert, wenn der pszVerificationText-ParameterNULL ist.
TDF_SHOW_PROGRESS_BAR	Gibt an, dass eine Statusleiste angezeigt werden soll.
TDF_SHOW_MARQUEE_PROGRESS_BAR	Gibt an, dass eine Marquee-Statusleiste angezeigt werden soll.
TDF_CALLBACK_TIMER	Gibt an, dass der Rückruf des Aufgabendialogfelds ungefähr alle 200 Millisekunden aufgerufen werden soll.
TDF_POSITION_RELATIVE_TO_WINDOW	Gibt an, dass das Aufgabendialogfeld relativ zum von hwndParent angegebenen Fenster positioniert (zentriert) ist. Wenn das Flag nicht angegeben wird (oder kein hwndParent-Member angegeben ist), wird das Aufgabendialogfeld relativ zum Monitor positioniert (zentriert).
TDF_RTL_LAYOUT	Gibt an, dass Text von rechts nach links angezeigt wird.
TDF_NO_DEFAULT_RADIO_BUTTON	Gibt an, dass kein Standardelement ausgewählt wird.
TDF_CAN_BE_MINIMIZED	Gibt an, dass das Aufgabendialogfeld minimiert werden kann.
TDIF_SIZE_TO_CONTENT	Dieses Flag ist veraltet. Verwenden Sie stattdessen TDF_SIZE_TO_CONTENT .
TDF_SIZE_TO_CONTENT	Gibt an, dass die Breite des Aufgabendialogfelds durch die Breite des Inhaltsbereichs bestimmt wird. Dieses Flag wird ignoriert, wenn cxWidth nicht auf 0 festgelegt ist.

dwCommonButtons

Typ: TASKDIALOG_COMMON_BUTTON_FLAGS

Gibt die im Aufgabendialogfeld angezeigten Drucktasten an. Wenn keine allgemeinen Schaltflächen angegeben und keine benutzerdefinierten Schaltflächen mithilfe der Elemente cButtons und pButtons angegeben werden, enthält das Aufgabendialogfeld standardmäßig die Schaltfläche OK . Dieser Parameter kann eine Kombination von Flags aus der folgenden Gruppe sein:

Wert	Bedeutung
TDCBF_OK_BUTTON	Das Aufgabendialogfeld enthält die Schaltfläche " OK".
TDCBF_YES_BUTTON	Das Aufgabendialogfeld enthält die Schaltfläche " Ja".
TDCBF_NO_BUTTON	Das Aufgabendialogfeld enthält die Schaltfläche " Nein".
TDCBF_CANCEL_BUTTON	Das Aufgabendialogfeld enthält die Schaltfläche " Abbrechen". Wenn diese Schaltfläche angegeben ist, reagiert das Aufgabendialogfeld auf typische Abbruchaktionen (ALT-F4 und Escape).
TDCBF_RETRY_BUTTON	Das Aufgabendialogfeld enthält die Schaltfläche " Wiederholen".
TDCBF_CLOSE_BUTTON	Das Aufgabendialogfeld enthält die Schaltfläche " Schließen".

pszWindowTitle

Typ: PCWSTR

Zeiger, der auf die Zeichenfolge verweist, die für den Aufgabendialogtitel verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird. Wenn dieser Parameter NULL ist, wird der Dateiname des ausführbaren Programms verwendet.

DUMMYUNIONNAME

DUMMYUNIONNAME.hMainIcon

Typ: HICON

Ein Handle für ein Symbol, das im Aufgabendialogfeld angezeigt werden soll. Dieses Element wird ignoriert, es sei denn, das TDF_USE_HICON_MAIN-Flag wird angegeben. Wenn dieses Element NULL ist und die TDF_USE_HICON_MAIN angegeben ist, wird kein Symbol angezeigt.

DUMMYUNIONNAME.pszMainIcon

Typ: PCWSTR

Zeiger, der auf das Symbol verweist, das im Aufgabendialogfeld angezeigt werden soll. Dieser Parameter wird ignoriert, wenn das USE_HICON_MAIN-Flag angegeben ist. Andernfalls wird kein Symbol angezeigt, wenn dieser Parameter NULL oder derhInstance-Parameter NULL ist. Bei diesem Parameter muss es sich um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro oder einen der folgenden vordefinierten Werte übergeben wird:

Wert	Bedeutung
TD_ERROR_ICON	Im Aufgabendialogfeld wird ein Stoppzeichensymbol angezeigt.
TD_WARNING_ICON	Im Aufgabendialogfeld wird ein Ausrufezeichen angezeigt.
TD_INFORMATION_ICON	Im Aufgabendialogfeld wird ein Symbol angezeigt, das aus einem Kleinbuchstaben i in einem Kreis besteht.
TD_SHIELD_ICON	Im Aufgabendialogfeld wird ein Schildsymbol angezeigt.

pszMainInstruction

Typ: PCWSTR

Zeiger, der auf die Zeichenfolge verweist, die für die Standard-Anweisung verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird.

pszContent

Typ: PCWSTR

Zeiger, der auf die Zeichenfolge verweist, die für den primären Inhalt des Dialogfelds verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird. Wenn das ENABLE_HYPERLINKS-Flag für den dwFlags-Member angegeben ist, kann diese Zeichenfolge Hyperlinks in der Form enthalten: <A HREF="executablestring">Hyperlink Text</A>. WARNUNG: Das Aktivieren von Hyperlinks bei der Verwendung von Inhalten aus einer unsicheren Quelle kann zu Sicherheitsrisiken führen.

cButtons

Typ: UINT

Die Anzahl der Einträge im pButtons-Array , das zum Erstellen von Schaltflächen oder Befehlslinks im Aufgabendialogfeld verwendet wird. Wenn dieser Member null ist und keine allgemeinen Schaltflächen mithilfe des dwCommonButtons-Elements angegeben wurden, wird im Aufgabendialogfeld eine einzelne OK-Schaltfläche angezeigt.

pButtons

Typ: const TASKDIALOG_BUTTON*

Zeiger auf ein Array von TASKDIALOG_BUTTON Strukturen, die die Definition der benutzerdefinierten Schaltflächen enthalten, die im Aufgabendialogfeld angezeigt werden sollen. Dieses Array muss mindestens die Anzahl von Einträgen enthalten, die vom cButtons-Element angegeben werden.

nDefaultButton

Typ: int

Die Standardschaltfläche für das Aufgabendialogfeld. Dies kann einer der Werte sein, die in nButtonID-Membern einer der TASKDIALOG_BUTTON-Strukturen im pButtons-Array angegeben sind, oder einer der IDs, die den im dwCommonButtons-Member angegebenen Schaltflächen entsprechen:

IDCANCEL	Legen Sie die Schaltfläche Abbrechen als Standard fest.
IDNO	Legen Sie die Schaltfläche Nein als Standard fest.
IDOK	Legen Sie die Schaltfläche OK als Standard fest.
IDRETRY	Legen Sie die Schaltfläche Wiederholen als Standard fest.
IDYES	Legen Sie die Schaltfläche Ja als Standard fest.
IDCLOSE	Legen Sie die Schaltfläche Schließen als Standard fest.

Wenn dieser Member 0 ist oder sein Wert keiner Schaltflächen-ID im Dialogfeld entspricht, ist die erste Schaltfläche im Dialogfeld die Standardeinstellung.

cRadioButtons

Typ: UINT

Die Anzahl der Einträge im pRadioButtons-Array , das zum Erstellen von Optionsfeldern im Aufgabendialogfeld verwendet wird.

pRadioButtons

Typ: const TASKDIALOG_BUTTON*

Zeiger auf ein Array von TASKDIALOG_BUTTON Strukturen, die die Definition der Optionsfelder enthalten, die im Aufgabendialogfeld angezeigt werden sollen. Dieses Array muss mindestens die Anzahl von Einträgen enthalten, die vom cRadioButtons-Element angegeben werden. Dieser Parameter kann NULL sein.

nDefaultRadioButton

Typ: int

Die Schaltflächen-ID des Optionsfelds, das standardmäßig ausgewählt ist. Wenn dieser Wert nicht einer Schaltflächen-ID entspricht, wird standardmäßig die erste Schaltfläche im Array ausgewählt.

pszVerificationText

Typ: PCWSTR

Zeiger, der auf die Zeichenfolge verweist, die zum Bezeichnen des Überprüfungskontrollkästchens verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird. Wenn dieser Parameter NULL ist, wird das Überprüfungskontrollkästchen im Aufgabendialogfeld nicht angezeigt. Wenn der pfVerificationFlagChecked-Parameter von TaskDialogIndirectNULL ist, ist das Kontrollkästchen nicht aktiviert.

pszExpandedInformation

Typ: PCWSTR

Zeiger, der auf die Zeichenfolge verweist, die zum Anzeigen zusätzlicher Informationen verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird. Die zusätzlichen Informationen werden entweder direkt unter dem Inhalt oder unter dem Fußzeilentext angezeigt, je nachdem, ob das TDF_EXPAND_FOOTER_AREA Flag angegeben ist. Wenn das TDF_ENABLE_HYPERLINKS-Flag für den dwFlags-Member angegeben ist, kann diese Zeichenfolge Hyperlinks in der Form enthalten: <A HREF="executablestring">Hyperlink Text</A>. WARNUNG: Das Aktivieren von Hyperlinks bei der Verwendung von Inhalten aus einer unsicheren Quelle kann zu Sicherheitsrisiken führen.

pszExpandedControlText

Typ: PCWSTR

Zeiger, der auf die Zeichenfolge verweist, die zum Bezeichnen der Schaltfläche zum Reduzieren der erweiterbaren Informationen verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird. Dieses Element wird ignoriert, wenn das element pszExpandedInformationNULL ist. Wenn dieser Member NULL ist und der pszCollapsedControlText angegeben wird, wird auch für dieses Element der Wert pszCollapsedControlText verwendet.

pszCollapsedControlText

Typ: PCWSTR

Zeiger, der auf die Zeichenfolge verweist, die zum Beschriften der Schaltfläche zum Erweitern der erweiterbaren Informationen verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird. Dieses Element wird ignoriert, wenn das element pszExpandedInformationNULL ist. Wenn dieser Member NULL ist und der pszCollapsedControlText angegeben wird, wird auch für dieses Element der Wert pszCollapsedControlText verwendet.

DUMMYUNIONNAME2

DUMMYUNIONNAME2.hFooterIcon

Typ: HICON

Ein Handle für ein Symbol, das in der Fußzeile des Aufgabendialogfelds angezeigt werden soll. Dieser Member wird ignoriert, es sei denn, das flag TDF_USE_HICON_FOOTER ist angegeben und das pszFooterIcon nicht. Wenn dieses Element NULL ist und die TDF_USE_HICON_FOOTER angegeben ist, wird kein Symbol angezeigt.

DUMMYUNIONNAME2.pszFooterIcon

Typ: PCWSTR

Zeiger, der auf das Symbol verweist, das im Fußzeilenbereich des Aufgabendialogfelds angezeigt werden soll. Dieser Parameter wird ignoriert, wenn das TDF_USE_HICON_FOOTER-Flag angegeben ist oder wenn pszFooterNULL ist. Andernfalls wird kein Symbol angezeigt, wenn dieser Parameter NULL oder derhInstance-Parameter NULL ist. Bei diesem Parameter muss es sich um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird, oder um einen der vordefinierten Werte, die für pszMainIcon aufgeführt sind.

pszFooter

Typ: PCWSTR

Zeiger auf die Zeichenfolge, die im Fußzeilenbereich des Aufgabendialogfelds verwendet werden soll. Bei diesem Parameter kann es sich um eine null-beendete Zeichenfolge oder um einen ganzzahligen Ressourcenbezeichner handeln, der an das MAKEINTRESOURCE-Makro übergeben wird. Wenn das TDF_ENABLE_HYPERLINKS-Flag für das dwFlags-Element angegeben ist, kann diese Zeichenfolge Hyperlinks in dieser Form enthalten.

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

Warnung Das Aktivieren von Hyperlinks bei der Verwendung von Inhalten aus einer unsicheren Quelle kann zu Sicherheitsrisiken führen.

pfCallback

Typ: PFTASKDIALOGCALLBACK

Zeiger auf eine anwendungsdefinierte Rückruffunktion. Weitere Informationen finden Sie unter TaskDialogCallbackProc.

lpCallbackData

Typ: LONG_PTR

Ein Zeiger auf anwendungsdefinierte Verweisdaten. Dieser Wert wird vom Aufrufer definiert.

cxWidth

Typ: UINT

Die Breite des Clientbereichs des Aufgabendialogfelds in Dialogeinheiten. Wenn 0, berechnet der Taskdialog-Manager die ideale Breite.

Anforderungen


Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Kopfzeile	commctrl.h

Freigeben über

TASKDIALOGCONFIG-Struktur (commctrl.h)

Syntax

Member

Anforderungen

Feedback

Zusätzliche Ressourcen