Kernel32FormatMessage Method

[DllImportAttribute("Kernel32.dll", CharSet = CharSet.Auto, SetLastError = true)]
public static int FormatMessage(
	FormatMessageFlags flags,
	IntPtr source,
	uint messageId,
	uint languageId,
	ref IntPtr refBuffer,
	uint size,
	string[] arguments
)

<DllImportAttribute("Kernel32.dll", CharSet := CharSet.Auto, SetLastError := true>]
Public Shared Function FormatMessage ( 
	flags As FormatMessageFlags,
	source As IntPtr,
	messageId As UInteger,
	languageId As UInteger,
	ByRef refBuffer As IntPtr,
	size As UInteger,
	arguments As String()
) As Integer

Dim flags As FormatMessageFlags
Dim source As IntPtr
Dim messageId As UInteger
Dim languageId As UInteger
Dim refBuffer As IntPtr
Dim size As UInteger
Dim arguments As String()

Dim returnValue As Integer

returnValue = Kernel32.FormatMessage(flags, 
	source, messageId, languageId, refBuffer, 
	size, arguments)

public:
[DllImportAttribute(L"Kernel32.dll", CharSet = CharSet::Auto, SetLastError = true)]
static int FormatMessage(
	FormatMessageFlags flags, 
	IntPtr source, 
	unsigned int messageId, 
	unsigned int languageId, 
	IntPtr% refBuffer, 
	unsigned int size, 
	array<String^>^ arguments
)

[<DllImportAttribute("Kernel32.dll", CharSet = CharSet.Auto, SetLastError = true)>]
static member FormatMessage : 
        flags : FormatMessageFlags * 
        source : IntPtr * 
        messageId : uint32 * 
        languageId : uint32 * 
        refBuffer : IntPtr byref * 
        size : uint32 * 
        arguments : string[] -> int 

No code example is currently available or this language may not be supported.

Parameters

flags  FormatMessageFlags

The formatting options, and how to interpret the source parameter.

The low-order byte of flags parameter 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.

source  IntPtr

The location of the message definition.

The type of this parameter depends upon the settings in the flags parameter.

messageId  UInt32

The message identifier for the requested message.

This parameter is ignored if flags includes FromString.

languageId  UInt32

The language identifier for the requested message.

This parameter is ignored if flags includes FromString.

refBuffer  IntPtr

A pointer to a buffer that receives the null-terminated string that specifies the formatted message.

If flags includes AllocateBuffer, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in refBuffer.

This buffer cannot be larger than 64K bytes.

size  UInt32

If the AllocateBuffer flag is not set, this parameter specifies the size of the output buffer.

If AllocateBuffer is set, this parameter specifies the minimum number of characters to allocate for an output buffer.

Thhe output buffer cannot be larger than 64K bytes.

arguments  String

An array of values that are used as insert values in the formatted message.

A %1 in the format string indicates the first value in the Arguments array; a %2 indicates the second argument; and so on.

The interpretation of each value depends on the formatting information associated with the insert in the message definition. The default is to treat each value as a pointer to a null-terminated string.

Return Value

If the function fails, the return value is .

To get extended error information, call GetLastWin32Error.

Reference