A | B | C |  D | E | F |  G | H | I |  J | K | L |  M | N | O |  P | Q | R |  S | T | U |  V | W | X |  Y | Z


The RasGetErrorString function obtains an error message string for a specified RAS error value.

Declare Function RasGetErrorString Lib "rasapi32.dll" Alias "RasGetErrorStringA" (ByVal uErrorValue As Long, ByVal lpszErrorString As String, ByVal cBufSize As Long) As Long

Operating Systems Supported
Requires Windows NT 3.1 or later; Requires Windows 95 or later


Parameter Information
- uErrorValue
Specifies the error value of interest. These are values returned by one of the RAS functions: those listed in the RAS header file.

- lpszErrorString
Points to a buffer that the function will write the error string to. This parameter must not be NULL.

- cBufSize
Specifies the size, in characters, of the buffer pointed to by lpszErrorString.

Return Values
If the function succeeds, the return value is zero.

If the function fails, the return value is a nonzero error value. This value is ERROR_INVALID_PARAMETER or the GetLastError value returned from the functions GlobalAlloc or LoadString. The function does not set a threadís last error information; that is, there is no GetLastError information set by the RasGetErrorString function.

Last update: 07 April 2006