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

POPSTORE_format_profiles_d

Format for display a list of user profiles.
FORMAT 


int POPSTORE_format_profiles_d (format, domain, domain_len, 
                                group, group_len, user, 
                                user_len, context, 
                                output_proc) 
      POPSTORE_format_element  *format; 
      char                     *domain; 
      int                       domain_len; 
      char                     *group; 
      int                       group_len; 
      char                     *user; 
      int                       user_len; 
      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 to use. 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.

group

Name of the management group and subgroups thereof to restrict the listing to. Supply a value of NULL if accounts from any group should be listed. This string cannot contain wild cards. Used for input only.

group_len

Length in bytes of the group name, group. Specify a value of zero if you do not want to restrict the listing to a particular group.

user

Name of the user to display profile information for. This string can contain wild cards. Used for input only.

user_len

Length in bytes of the username string, user. Length of this string can not exceed ALFA_SIZE bytes. 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

Use POPSTORE_format_profiles_d to generate a listing of popstore user accounts. When group_len is zero, all accounts matching the username specification, user, will be formatted for display. When group_len is larger than zero, only those accounts within the specified management group and matching the username specification will be formatted for display. The username specification is treated as a case-insensitive string and can contain wild card characters. To list all accounts you can simply pass a null value for user or a zero value for user_len or both. The formatting context passed to this subroutine should be derived from a formatting file using substitution strings from Tables 4-10 and 4-15. 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 Length of username string exceeds ALFA_SIZE bytes.
  Any error value returned by the output procedure, output_proc.

Previous Next Contents Index