GetCsvReturnCode

The GetCsvReturnCode function converts the primary and secondary return codes in the verb control block to a printable string. This function provides a standard set of error strings for use by applications using CSVs.

int WINAPI GetCsvReturnCode(
struct csv_hdr FAR * vpb,
UINT buffer_length,
unsigned char FAR * buffer_addr
);

Parameters

vpb

Supplied parameter. Specifies the address of the verb control block.

buffer_length

Supplied parameter. Specifies the length of the buffer pointed to by buffer_addr. The recommended length is 256.

buffer_addr

Supplied parameter. Specifies the address of the buffer that will hold the formatted, null-terminated string when the function completes.

Return Values

The GetCsvReturnCode function returns a positive value on success that indicates the length of the error string passed back in buffer_addr.

A return value of zero indicates an error. On Microsoft® Windows NT® and Microsoft® Windows® 95, a call to GetLastError provides the actual error return code as follows:

0x20000001

The parameters are invalid; the function could not read from the specified verb parameter block or could not write to the specified buffer.

0x20000002

The specified buffer is too small.

0x20000003

The CSV string library CSVSTR.DLL (for Microsoft® Windows® version 3.x) or CSVST32.DLL (for Windows NT and Windows 95) could not be loaded.

Remarks

The descriptive error string returned in buffer_addr does not terminate with a newline character (\n).

The descriptive error strings are contained in CSVSTR.DLL (for Windows version 3.x) or CSVST32.DLL (for Windows NT and Windows 95) and can be customized for different languages.