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

Previous | Contents

POPSTORE_command

Obsolete subroutine: use the more general POPSTORE_command_d subroutine.
FORMAT 
int POPSTORE_command (command, command_len, 
                      password_required, 
                      user, user_len, 
                      password, password_len, 
                      usage, usage_len, 
                      out_info, out_info_len, 
                      context, output_proc) 
      char  *command; 
      int    command_len; 
      int    password_required 
      char  *user; 
      int    user_len; 
      char  *password; 
      int    password_len; 
      char  *usage; 
      int    usage_len; 
      char  *out_info; 
      int   *out_info_len; 
      void  *context; 
      int  (*output_proc)();

ARGUMENTS

command

The command to process. Used for input only.

command_len

Length in bytes of the command specified with command. Used for input only.

password_required

Boolean flag indicating whether or not password authentication is required in order to process the command. Used for input only.

user

Name of the popstore user account to authenticate against when password authentication is required. Used for input only.

user_len

Length in bytes of the username specified with user. Used for input only.

password

User-supplied, plain text password to use when performing a password authentication. Used for input only.

password_len

Length in bytes of the plain text password specified with password. Used for input only.

usage

Usage description to be passed to site-supplied logging subroutines explaining the usage. Used for input only.

usage_len

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

out_info

Output buffer to receive post-processing information. Used for output only.

out_info_len

On input, the maximum length in bytes of the buffer pointed at by out_info. On output, the length in bytes of the information placed in the out_info buffer. Used for input and output.

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 receive command processing output. Used for input only.

DESCRIPTION

Although still supported, this subroutine is now obsolete. Use the more general POPSTORE_command_d subroutine instead.
Return Values
POPSTORE_SUCCESS Normal, successful completion.
POPSTORE_BADARG Null value received for the out_proc argument.
POPSTORE_ERRORS The command was parsed and executed; execution of the command resulted in some errors which were reported via the output_proc procedure.
POPSTORE_AUTHFAIL Invalid password or username supplied. The command was not executed.
POPSTORE_BADHEXVAL The command contained an illegal hexadecimal encoded character. The command was not executed.
POPSTORE_CMDTOOLONG The command contained too many name=value pairs. The command was not executed.
POPSTORE_CMDUNKOWN The command contained an unrecognized right-hand-side in a name=value pair. The command was not executed.
POPSTORE_CMDUNKOWNL The command contained an unrecognized left-hand-side in a name=value pair. The command was not executed.
POPSTORE_NOMANAGE Specified account lacks management privileges. The command was not executed.
POPSTORE_PWDREQUIRED A username and password are required. The command was not executed.
POPSTORE_VMERROR Insufficient virtual memory. The command was not executed.
Any error returned by the output_proc procedure.

Previous | Next | Contents