# Function Reference

# _WinAPI_FormatMessage

Formats a message string

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

## Parameters

$iFlags | Contains a set of bit flags that specify aspects of the formatting process and how to interpret the $pSource parameter. The low-order byte of $iFlags specifies how the function handles line breaks in the output buffer. The low-order byte can also specify the maximum width of a formatted output line. See MSDN Web info for complete description.
$pSource | Pointer to message source
$iMessageID | Requested message identifier
$iLanguageID | Language identifier for requested message
$pBuffer | Pointer to message buffer or string variable that will contain the message
$iSize | Maximum size of message buffer
$vArguments | Address of array of message inserts

## Return Value

Success: | Number of bytes stored in message buffer
Failure: | Set the @error flag to on-zero, @extended = _WinAPI_GetLastError(). Call _WinAPI_GetErrorMessage(@extended) to edit @extended.

## Related

_WinAPI_GetLastError, _WinAPI_GetErrorMessage

## See Also

Search FormatMessage in MSDN Library.