PMDF popstore & MessageStore Manager's Guide
PMDF-POP-6.0

Previous | Contents

POPSTORE_user_list

Obsolete subroutine: use the more general POPSTORE_user_list_d subroutine.
FORMAT 
int POPSTORE_user_list (list_context, pattern, pattern_len, 
                        user, user_len, max_user_len) 
      POPSTORE_list_context **list_context; 
      char                   *pattern; 
      int                     pattern_len; 
      char                   *user; 
      int                    *user_len; 
      int                     max_user_len;

ARGUMENTS

user_context

List context maintained by POPSTORE_user_list. Used for input and output.

pattern

Optional username pattern. Used for input only.

pattern_len

Length in bytes of the optional username pattern, pattern. Used for input only.

user

Buffer to receive the returned username. Length of this buffer should be at least POPSTORE_MAX_USER_LEN+1 bytes long. Used for output only.

user_len

Length in bytes of the username returned in user. Used for output only.

max_user_len

Maximum length in bytes of the buffer, user. Used for input only.

DESCRIPTION

Although still supported, POPSTORE_user_list is obsolete. Instead use the more general POPSTORE_user_list_d subroutine.
Return Values
POPSTORE_SUCCESS Normal, successful completion.
POPSTORE_BADARG Bad value supplied for the list_context, user, user_len, or max_user_len argument.
POPSTORE_DBBADLENGTH Retrieved a record from the database which has an unexpected length. In practice, this error should never occur.
POPSTORE_DBERR An unknown error occurred while attempting to read from the user database. In practice, this error should never occur.
POPSTORE_DBOPNERR Unable to open the user database.
POPSTORE_DBMISSING User database does not exist; create it with the X-BUILD-USER-DB command of the command-line popstore management utility.
POPSTORE_EOM No more usernames to return
POPSTORE_FILOPNERR Unable to open the profile path file. See Section 14.2 for details.
POPSTORE_INSUFPRIV Process has insufficient privileges to access the user database.
POPSTORE_VMERROR Insufficient virtual memory.

Previous | Next | Contents