extern char* bpc_error_allocate

(struct CHANNEL_INSTANCE* inst,
  int code, char* language,
  char* message)

Allocates a buffer containing an <error> element.

Documentation

Allocates a buffer containing an <error> element.

Use bpc_buffer_destroy to deallocate the buffer returned, but only if it has not been used as a parameter to bpc_send. (If the channel instance is NULL, then use lib_free to free it.)

Parameters:
inst - A pointer to the channel-instance structure.
code - The value to use for the code attribute of the <close> element. Consult Section 8 of RFC 3080 for an (incomplete) list.
language - The value to use for the xml:lang attribute of the <error> element.
message - A textual message corresponding to the code parameter.
Returns:
The buffer that is allocated, or NULL.

Home Alphabetic index



This page was generated with the help of DOC++.