ConfirmBox()

Aus Wiki des Deutschsprachige Xbaseentwickler e. V.
Zur Navigation springen Zur Suche springen

Allgemeines

Die Funktion ConfirmBox() ist ein Wrapper für einen Standard-Windows-Dialog, der mit einigen vordefinierten Icons und Buttons konfiguriert werden kann. Die Funktion eignet sich für Ad-hoc-Abfragen im Rahmen eines Programmes.


Syntax

ConfirmBox([<oOwner>], <cNachricht>, [<cTitel>], [<nButtons>], [<nIcon>], [<nStartButton>]) => [nAnswer]


Parameter

<oOwner> definiert den Owner der ConfirmBox(). Ist dieser Parameter nicht angegeben, wird der Rückgabewert von SetAppWindow() verwendet.

<cNachricht> ist ein String, der als Nachricht in der ConfirmBox() angezeigt werden soll.

<cTitel> ist ein optionaler String, der in der Titlebar des Fensters angezeigt wird.

<nButtons> ist ein optionaler Wert, der angibt, welche Button-Kombination angezeigt werden soll. Möglich sind die folgenden Werte:

XBPMB_OK OK
XBPMB_OKCANCEL OK und CANCEL
XBPMB_RETRYCANCEL RETRY und CANCEL
XBPMB_ABORTRETRYIGNORE ABORT, RETRY und IGNORE
XBPMB_YESNO YES und NO
XBPMB_YESNOCANCEL YES, NO und CANCEL

<nIcon> ist ein optionaler Parameter, mittels dem ein vordefiniertes Icon linksbündig in der ConfirmBox() dargestellt werden kann.

XBPMB_NOICON es wird kein Icon dargestellt (Unterlassungswert)
XBPMB_QUESTION Fragezeichen
XBPMB_WARNING Warnung
XBPMB_INFORMATION Informationeller Hinweis
XBPMB_CRITICAL kritische Situation

<nStartButton> gibt an, welcher Button voreingestellt sein soll.


Rückgabewert

nAnswer gibt an, welche Aktion der Benutzer ausgeführt hat. Es gibt die folgenden Möglichkeiten:

XBPMB_RET_OK OK wurde ausgewählt
XBPMB_RET_CANCEL CANCEL wurde ausgewählt
XBPMB_RET_ABORT ABORT wurde ausgewählt
XBPMB_RET_RETRY RETRY wurde ausgewählt
XBPMB_RET_IGNORE IGNORE wurde ausgewählt
XBPMB_RET_YES YES wurde ausgewählt
XBPMB_RET_NO NO wurde ausgewählt
XBPMB_RET_ENTER ENTER wurde ausgewählt
XBPMB_RET_ERROR ConfirmBox() konnte nicht angezeigt werden


Besonderheiten

Es können keine anderen als die vorgegebenen Kombinationen ausgewählt werden, da es sich um einen Windows-Standard-Dialog handelt.

Das Programm muss mit /PM:PM gelinkt werden.


Querverweise

(keine)


benötigte DLLs bzw. Include-Dateien

XbpRt1.DLL Xbp.CH


Zuordnung

Programm-Benutzer-Kommunikation.


Anwendungsbeispiel

nAnswer := ConfirmBox(, "Soll das Programm tatsächlich beendet werden?", "Programmabbruch", XBPMB_OKCANCEL, XBPMB_QUESTION)
IF nAnswer == XBPMB_RET_OK
  QUIT
ENDIF


weitere Hinweise

Informationen zum Windows-API finden sich hier: MSDN Library

Diskussionen im Forum finden sich hier: [1] und hier: [2]