Funktionreferenz


_WinAPI_FormatMessage

Beschreibung anzeigen in

Formatiert einen Nachrichtenstring

#include <WinAPIError.au3>
_WinAPI_FormatMessage ( $iFlags, $pSource, $iMessageID, $iLanguageID, ByRef $pBuffer, $iSize, $vArguments )

Parameter

$iFlags Enthält einen Satz von Bitflags, welche die Aspekte des Formatierungsprozesses festlegen und wie der $pSource Parameter interpretiert werden soll.
Das Low-Order Byte (LOWORD) von $iFlags legt fest wie Zeilenumbrüche im Ausgabepuffer gehandhabt werden sollen.
Das Low-Order Byte kann ebenso die Länge des zu formatierenden Strings festlegen.
Siehe MSDN-Web für eine vollständige Beschreibung.
$pSource Zeiger auf die Nachrichtenquelle. Dieser Parameter ist abhängig von den gesetzten Bits in $iFlags. Ist in $iFlags
weder FORMAT_MESSAGE_FROM_HMODULE noch FORMAT_MESSAGE_FROM_STRING gesetzt, wird $pSource ignoriert.
$iMessageID Identifizierer der angeforderten Nachricht. Dieser Parameter wird ignoriert, wenn in $iFlags FORMAT_MESSAGE_FROM_STRING gesetzt ist.
$iLanguageID Identifizierer der Sprache für die angeforderte Nachricht. Dieser Parameter wird ignoriert,
    wenn in $iFlags FORMAT_MESSAGE_FROM_STRING gesetzt ist.
$pBuffer Zeiger auf einen Ausgabepuffer oder eine Stringvariable, der die angeforderte Nachricht aufnimmt
$iSize Falls das FORMAT_MESSAGE_ALLOCATE_BUFFER-Flag nicht gesetzt ist, dann legt $iSize die Größe des Ausgabepuffers in Zeichen fest.
    Ist dagegen das FORMAT_MESSAGE_ALLOCATE_BUFFER-Flag gesetzt, gibt $iSize die minimale Größe des Ausgabepuffers an.
    Der Ausgabepuffer darf nicht Größer als 64KB sein.
$vArguments Ein Array mit Werten die in die Nachricht eingefügt werden sollen. Im zu formatierenden String steht %1 stellvertretend für
    den ersten Wert im Array, %2 für den zweiten Wert, %3 für den dritten usw.

Rückgabewert

Erfolg: Anzahl der Bytes im Ausgabepuffer
Fehler: Setzt das @error Flag auf ungleich null. @extended = _WinAPI_GetLastError().
    Es ist _WinAPI_GetErrorMessage(@extended) aufzurufen, um @extended zu ändern.

Siehe auch

Suche nach FormatMessageA in der MSDN Bibliothek.