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

Previous | Contents

POPSTORE_user_begin

Obsolete subroutine: use the more general POPSTORE_user_begin_d subroutine.
FORMAT 
int POPSTORE_user_begin (user_context, user, user_len, 
                         do_accounting, usage, usage_len) 
      POPSTORE_user_context **user_context; 
      char                   *user; 
      int                     user_len; 
      int                     do_accounting; 
      char                   *usage; 
      int                     usage_len;

ARGUMENTS

user_context

User context returned by a successful call to this subroutine. Used for output only.

user

Name of the popstore user to obtain a user context for. Used for input only.

user_len

Length in bytes of the username string, user. Used for input only.

do_accounting

Boolean flag indicating whether or not to update accounting information for this user when the user context is disposed of. Used for input only.

usage

A short description identifying the usage being made by the caller. This description is passed to site-supplied logging subroutines for logging purposes. Used for input only.

usage_len

Length in bytes of the usage description, usage. Used for input only.

DESCRIPTION

While this subroutine is still supported, it is now obsolete. Use the more general POPSTORE_user_begin_d subroutine.
Return Values
POPSTORE_SUCCESS Normal, successful completion.
POPSTORE_FILOPNERR Unable to open the profile file for reading.
POPSTORE_INSUFPRIV Insufficient privileges to access the profile file, or, on OpenVMS, the process lacks SYSLCK privilege.
POPSTORE_LCKOPNERR Unable to obtain lock information for the profile file.
POPSTORE_LOCKERROR Unable to obtain a lock for the profile file.
POPSTORE_NOSUCHUSR No such user account.
POPSTORE_READERROR An error while attempting to read data from the profile file.
POPSTORE_TOOLONG The resulting profile file name is too long.
POPSTORE_VMERROR Insufficient virtual memory.

Previous | Next | Contents