10.2.3 SPTHGetErrorMessage (get an error message)

Purpose

Gets an error message.

Prototype declaration

DWORD  APIENTRY  SPTHGetErrorMessage
(
      DWORD  dwErrorCode,
      LPSTR  lpszMessage,
      DWORD  dwSize
  );

Arguments

dwErrorCode: Specify the error code obtained by the GetLastError function.
lpszMessage: Specify a pointer to the buffer in which to store the error message.
dwSize: Specify the byte size (including \0) of the buffer in which to store the error message. If the specified size is too small, the message will be truncated.

Return values

Error message (excluding \0).

JP1/Script version

Supported from JP1/Script 05-00.