Obtains information about a user from the user profile database.
Format
MAIL$USER_GET_INFO context ,in_item_list ,out_item_list
1 – Returns
OpenVMS usage:cond_value
type: longword (unsigned)
access: write only
mechanism: by value
Longword condition value. All utility routines return a condition
value in R0. Condition values that can be returned by this
routine are listed under Condition Values Returned.
2 – Arguments
context
OpenVMS usage:context
type: longword (unsigned)
access: modify
mechanism: by reference
User context information to be passed to user routines. The
context argument is the address of a longword that contains user
context information returned by MAIL$USER_BEGIN.
in_item_list
OpenVMS usage:itmlst_3
type: longword (unsigned)
access: read only
mechanism: by reference
Item list specifying options for the routine. The in_item_list
argument is the address of a list of item descriptors, each of
which specifies an option and provides the information needed to
perform the operation.
The item list must include at least one device item descriptor.
The item list is terminated by longword value of 0.
3 – Input Item Codes
MAIL$_USER_FIRST
The Boolean item code MAIL$_USER_FIRST specifies that MAIL$USER_
GET_INFO return information in the user profile about the first
entry in the user profile database.
Specify the value 0 in the buffer length and buffer address
fields of the item descriptor.
Do not specify MAIL$_USER_FIRST, MAIL$_USER_NEXT or MAIL$_USER_
USERNAME in the same call to MAIL$USER_GET_INFO.
MAIL$_USER_NEXT
The Boolean item code MAIL$_USER_NEXT specifies that MAIL$USER_
GET_INFO return information in the user profile about the next
user.
Specify the value 0 in the buffer length and buffer address
fields of the item descriptor.
Do not specify MAIL$_USER_FIRST, MAIL$_USER_NEXT or MAIL$_USER_
USERNAME in the same call to MAIL$USER_GET_INFO.
MAIL$_USER_USERNAME
The item code MAIL$_USER_USERNAME points to the username string.
Specify the address of the username string in the buffer address
field and specify the length of the username string in the buffer
length field of the item descriptor.
Do not specify MAIL$_USER_FIRST, MAIL$_USER_NEXT and MAIL$_USER_
USERNAME in the same call to MAIL$USER_GET_INFO.
out_item_list
OpenVMS usage:itmlst_3
type: longword
access: write only
mechanism: by reference
Item list specifying the information you want the routine to
return. The out_item_list argument is the address of a list of
item descriptors, each of which describes an item of information.
The list of item descriptors is terminated by longword value of
0.
4 – Output Item Codes
MAIL$_USER_AUTO_PURGE
When you specify the Boolean item code MAIL$_USER_AUTO_PURGE,
MAIL$USER_GET_INFO returns the value of the automatic purge mail
flag as a longword value.
MAIL$_USER_CC_PROMPT
When you specify the Boolean item code MAIL$_USER_CC_PROMPT,
MAIL$USER_GET_INFO returns the value of the cc prompt flag as a
longword value.
MAIL$_USER_COPY_FORWARD
When you specify the Boolean item code MAIL$_USER_COPY_FORWARD,
MAIL$USER_GET_INFO returns the value of the copy self forward
mail flag as a longword value.
MAIL$_USER_COPY_REPLY
When you specify the Boolean item code MAIL$_USER_COPY_REPLY,
MAIL$USER_GET_INFO returns the value of the copy self reply mail
flag as a longword value.
MAIL$_USER_COPY_SEND
When you specify the Boolean item code MAIL$_USER_COPY_SEND,
MAIL$USER_GET_INFO returns the value of the copy self send mail
flag as a longword value.
MAIL$_USER_EDITOR
When you specify MAIL$_USER_EDITOR, MAIL$USER_GET_INFO returns
the name of the default editor. The buffer address field of the
item descriptor points to a buffer that receives a character
string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_USER_FORWARDING
When you specify MAIL$_USER_FORWARDING, MAIL$USER_GET_INFO
returns the forwarding address. The buffer address field of the
item descriptor points to a buffer that receives a character
string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_USER_FORM
When you specify MAIL$_USER_FORM, MAIL$USER_GET_INFO returns the
default print form string. The buffer address field of the item
descriptor points to a buffer that receives a character string 0
to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_USER_FULL_DIRECTORY
When you specify MAIL$_USER_FULL_DIRECTORY, MAIL$USER_GET_INFO
returns the complete directory path of the MAIL subdirectory
string. The buffer address field of the item descriptor points
to a buffer that receives a character string 0 to 255 characters
long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_USER_NEW_MESSAGES
When you specify MAIL$_USER_NEW_MESSAGES, MAIL$USER_GET_INFO
returns the new messages count. The buffer address field of the
item descriptor points to a word that receives the new message
count as a word value.
MAIL$_USER_PERSONAL_NAME
When you specify MAIL$_USER_PERSONAL_NAME, MAIL$USER_GET_INFO
returns the personal name string. The buffer address field of
the item descriptor points to a buffer that receives a character
string 0 to 127 characters long.
Specify a value from 0 to 127 in the buffer length field of the
item descriptor.
MAIL$_USER_QUEUE
When you specify MAIL$_USER_QUEUE, MAIL$USER_GET_INFO returns
the default print queue name string. The buffer address field of
the item descriptor points to a buffer that receives a character
string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_USER_RETURN_USERNAME
When you specify MAIL$_USER_RETURN_USERNAME, MAIL$USER_GET_INFO
returns the user name. The buffer address field of the item
descriptor points to a buffer that receives a character string
0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_USER_SIGFILE
When you specify MAIL$_USER_SIGFILE, MAIL$USER_GET_INFO returns
the default signature file specification. The buffer address
field of the item descriptor points to a buffer that receives a
character string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
MAIL$_USER_SUB_DIRECTORY
When you specify MAIL$_USER_SUB_DIRECTORY, MAIL$USER_GET_INFO
returns the MAIL subdirectory specification string. The buffer
address field of the item descriptor points to a buffer that
receives a character string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer length field of the
item descriptor.
5 – Description
The MAIL$USER_GET_INFO routine returns information about
specified entries in the user profile database. If you do not
specify a user name, MAIL$USER_GET_INFO returns information about
the user name associated with the calling process. To obtain
information about a user name other than that associated with the
calling process, you need the SYSNAM privilege.
6 – Condition Values Returned
SS$_NORMAL Normal successful completion.
MAIL$_CONITMCOD The specified item codes perform conflicting
operations.
MAIL$_INVITMCOD The specified item code is invalid.
MAIL$_INVITMLEN The specified item length is invalid.
MAIL$_MISREQITEM The required item is missing.
MAIL$_NOSUCHUSR The specified user name is invalid.
MAIL$_NOSYSPRV The specified operation requires the SYSPRV
privilege.
SS$_ACCVIO Access violation.