PMDF popstore & MessageStore Manager's Guide
Previous Next Contents Index

POPSTORE_format_forwarding

Format forwarding information.
FORMAT 


int POPSTORE_format_forwarding (format, user, user_len, 
                                is_prefix, context, 
                                output_proc) 
      POPSTORE_format_element  *format; 
      char                     *user; 
      int                       user_len; 
      int                       is_prefix; 
      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

Name of the user to display the forwarding for. This string can not contain wild cards. The length of this string can not exceed POPSTORE_MAX_USER_LEN bytes. Used for input only.

user_len

Length in bytes of the username passed in user. Used for input Only.

is_prefix

Boolean flag with value 0 or 1 indicating whether or not to treat the specified username as a prefix. 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

Although still supported, this subroutine is obsolete. Instead use the more general POPSTORE_format_forwarding_d subroutine.

Return Values

POPSTORE_SUCCESS Normal, successful completion.
POPSTORE_BADARG Bad value passed for the address of the output procedure, output_proc.
POPSTORE_TOOLONG Username string is too long; it can not exceed a length of POPSTORE_MAX_USER_LEN bytes.
  Any error value returned by the output procedure, output_proc.

Previous Next Contents Index