Format a user's list of stored messages.

format

int POPSTORE_format_messages (format, user_context, context, output_proc) POPSTORE_format_element *format; POPSTORE_user_context *user_context; void *context; int (*output_proc)();

Arguments

format

Pointer to a formatting context returned by a previous call to POPSTORE_format_read . Used for input only.

user_context

User context for the user to display the messages for. Obtain this context by calling POPSTORE_user_begin_d . Used for input only.

context

Pointer to private client data to be passed to the client-supplied output_proc procedure. Used for input only.

output_proc

Address of a client-supplied subroutine to call to output formatted data. Used for input only.

Description

POPSTORE_format_messages can be used to format a user's list of stored messages. The formatting context passed to this subroutine should be derived from a formatting file using substitution strings from Tables 4-10 and 4-24. See the description of the POPSTORE_format_counters subroutine for a description of the output_proc procedure.

Return Values

POPSTORE_SUCCESS	Normal, successful completion.
POPSTORE_BADARG	Bad value passed for the address of the output procedure, output_proc.
	Any error value returned by the output procedure, output_proc.