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

POPSTORE_format_forwarding_d

Format forwarding information.
FORMAT 


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

domain

Name of the user domain associated with the user user. Supply a value of NULL to indicate the default domain. Used for input only.

domain_len

Length in bytes of the user domain name, domain. Supply a value of zero to indicate the default domain. 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 cannot 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

To generate a formatted display of forwarding information, use POPSTORE_format_forwarding. The formatting context passed to this subroutine should be derived from a formatting file using substitution strings from Tables 4-10 and 4-11. The supplied username is treated in a case-insensitive fashion and can not contain wild cards. An exact match will be done if is_prefix has the value 0. If is_prefix has a non-zero value, then the value of user will be treated as a prefix and all forwardings for usernames beginning with that value will be returned. For instance, if user has the value "D" and is_prefix is non-zero, then all forwardings for usernames beginning with the letter "D" will be returned. To return all of the forwardings, supply an empty string for user, the value 0 for user_len, and a non-zero value for is_prefix. 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.
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