GetAppcReturnCode()

This function converts the primary and secondary return codes in the VCB to a printable string. It provides a standard set of error strings for use by APPC applications.

Syntax

int WINAPI GetAppcReturnCode (struct appc_hdr *vcb,
                              UINT buffer_length,
                              unsigned char *buffer_addr);

Parameters

vcb

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/returned parameter; specifies the address of the buffer that will hold the formatted, null-terminated string. Length of the string in the specified buffer.

Returned Values

0x20000001

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

0x20000002

The specified buffer is too small.

Usage Notes

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