OpenVMS Utility Routines Manual
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_BEGIN returns the
subdirectory 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.
Description
MAIL$USER_BEGIN creates and initializes a user database context for
subsequent calls to other user routines.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
MAIL$_INVITMCOD
|
The specified item code is invalid.
|
|
MAIL$_INVITMLEN
|
The specified item length is invalid.
|
|
MAIL$_MISREQITEM
|
The required item is missing.
|
|
SS$_ACCVIO
|
Access violation.
|
MAIL$USER_DELETE_INFO
Removes a record from the user profile database.
Format
MAIL$USER_DELETE_INFO context ,in_item_list ,out_item_list
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.
Arguments
context
| OpenVMS usage: |
context |
| type: |
longword (unsigned) |
| access: |
modify |
| mechanism: |
by reference |
User context information to be passed to send 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.
Input Item Codes
MAIL$_USER_USERNAME
MAIL$_USER_USERNAME specifies the record to be deleted from the user
profile database. The buffer address field of the item
descriptor points to a buffer that contains the user name string
encoded in a character string 0 to 31 characters long.
Specify a value from 0 to 31 in the buffer
length field of the item descriptor.
The item code MAIL$_USER_USERNAME is required.
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.
Output Item Codes
None.
Description
To delete a record from the user profile database, you must have SYSPRV
privilege.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
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 not valid.
|
|
MAIL$_NOSYSPRV
|
The operation requires the SYSPRV privilege.
|
|
SS$_ACCVIO
|
Access violation.
|
MAIL$USER_END
Terminates access to the user profile database.
Format
MAIL$USER_END context ,in_item_list ,out_item_list
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.
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.
If the Mail utility terminates access to the user profile database
successfully, the value of the argument context is
changed to 0.
in_item_list
| OpenVMS usage: |
itmlst_3 |
| type: |
longword (unsigned) |
| access: |
read only |
| mechanism: |
by reference |
Item list specifying options for the routine. This routine does not use
the in_item_list argument.
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.
This routine does not use the out_item_list argument.
Description
The MAIL$USER_END routine deallocates the user database context created
by MAIL$USER_BEGIN as well as all dynamic memory allocated by previous
user routines.
Condition Values Returned
|
SS$_NORMAL
|
Normal successful completion.
|
|
MAIL$_INVITMCOD
|
The specified item code is invalid.
|
|
MAIL$_INVITMLEN
|
The specified item length is invalid.
|
|
MAIL$_MISREQITEM
|
The required item is missing.
|
|
SS$_ACCVIO
|
Access violation.
|
|
Any condition value returned by LIB$FREE_VM.
|
MAIL$USER_GET_INFO
Obtains information about a user from the user profile database.
Format
MAIL$USER_GET_INFO context ,in_item_list ,out_item_list
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.
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.
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.
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.
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.
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.
|
MAIL$USER_SET_INFO
Adds or modifies a specified user record in the user profile database.
Format
MAIL$USER_SET_INFO context ,in_item_list ,out_item_list
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.
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.
Input Item Codes
MAIL$_USER_CREATE_IF
The Boolean item code MAIL$_USER_CREATE_IF specifies that
MAIL$USER_SET_INFO should create the record for the specified user if
it does not already exist.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_AUTO_PURGE
MAIL$_USER_SET_NO_AUTO_PURGE
The Boolean item codes MAIL$_USER_SET_AUTO_PURGE and
MAIL$_USER_SET_NO_AUTO_PURGE set and clear the auto purge flag for the
specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_CC_PROMPT
MAIL$_USER_SET_NO_CC_PROMPT
The Boolean item codes MAIL$_USER_SET_CC_PROMPT and
MAIL$_USER_SET_NO_CC_PROMPT set and clear the cc prompt flag for the
specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_COPY_FORWARD
MAIL$_USER_SET_NO_COPY_FORWARD
The Boolean item codes MAIL$_USER_SET_COPY_FORWARD and
MAIL$_USER_SET_NO_COPY_FORWARD set and clear the copy self forward flag
for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_COPY_REPLY
MAIL$_USER_SET_NO_COPY_REPLY
The Boolean item codes MAIL$_USER_SET_COPY_REPLY and
MAIL$_USER_SET_NO_COPY_REPLY set and clear the copy self reply flag for
the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_COPY_SEND
MAIL$_USER_SET_NO_COPY_SEND
The Boolean item codes MAIL$_USER_SET_COPY_SEND and
MAIL$_USER_SET_NO_COPY_SEND set and clear the copy self send flag for
the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_EDITOR
MAIL$_USER_SET_NO_EDITOR
MAIL$_USER_SET_EDITOR specifies the name of a default editor to be used
by the specified user. The buffer address field of the
item descriptor points to a buffer that contains a character string 0
to 255 characters long.
Specify a value from 0 to 255 in the buffer
length field of the item descriptor.
The Boolean item code MAIL$_USER_SET_NO_EDITOR clears the default
editor field for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_FORM
MAIL$_USER_SET_NO_FORM
MAIL$_USER_SET_FORM specifies the default print form string for the
specified user. The buffer address field of the item
descriptor points to a buffer that contains a character string 0 to 255
characters long.
Specify a value from 0 to 255 in the buffer
length field of the item descriptor.
The Boolean item code MAIL$_USER_SET_NO_FORM clears the default print
form field for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_FORWARDING
MAIL$_USER_SET_NO_FORWARDING
MAIL$_USER_SET_FORWARDING specifies a forwarding address string for the
specified user. The buffer address field of the item
descriptor points to a buffer that contains a character string 0 to 255
characters long.
Specify a value from 0 to 255 in the buffer
length field of the item descriptor.
The Boolean item code MAIL$_USER_SET_NO_FORWARDING clears the
forwarding address field for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_NEW_MESSAGES
MAIL$_USER_SET_NEW_MESSAGES specifies the new message count for the
specified user. The buffer address field of the item
descriptor points to a word that contains the new number of new
messages.
MAIL$_USER_SET_PERSONAL_NAME
MAIL$_USER_SET_NO_PERSONAL_NAME
MAIL$_USER_SET_PERSONAL_NAME specifies a personal name string for the
specified user. The buffer address field of the item
descriptor points to a buffer that contains a character string 0 to 127
characters long.
Specify a value from 0 to 127 in the buffer
length field of the item descriptor.
The Boolean item code MAIL$_USER_SET_NO_PERSONAL_NAME clears the
personal field for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_QUEUE
MAIL$_USER_SET_NO_QUEUE
MAIL$_USER_SET_QUEUE specifies a default print queue name string for
the specified user. The buffer address field of the
item descriptor points to a buffer that contains a character string 0
to 255 characters long.
Specify a value from 0 to 255 in the buffer
length field of the item descriptor.
The Boolean item code MAIL$_USER_SET_NO_QUEUE clears the default print
queue field for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_SIGFILE
MAIL$_USER_SET_NO_SIGFILE
MAIL$_USER_SET_SIGFILE specifies a signature file specification for the
specified user. The buffer address field of the item
descriptor points to a buffer that contains a character string 0 to 255
characters long.
Specify a value from 0 to 255 in the buffer
length field of the item descriptor.
The Boolean item code MAIL$_USER_SET_NO_SIGFILE clears the signature
file field for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_SET_SUB_DIRECTORY
MAIL$_USER_SET_NO_SUB_DIRECTORY
MAIL$_USER_SET_SUB_DIRECTORY specifies a MAIL subdirectory. The
buffer address field of the item descriptor points to
a buffer that contains a character string 0 to 255 characters long.
Specify a value from 0 to 255 in the buffer
length field of the item descriptor.
The Boolean item code MAIL$_USER_SET_NO_SUB_DIRECTORY disables the use
of a MAIL subdirectory for the specified user.
Specify the value 0 in the buffer length and
buffer address fields of the item descriptor.
MAIL$_USER_USERNAME
MAIL$_USER_USERNAME specifies the record to be modified in the user
profile database and points to the user name string. The buffer
address field of the item descriptor points to a buffer that
contains a character string 0 to 31 characters long.
Specify a value from 0 to 31 in the buffer
length field of the item descriptor.
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.
Output Item Codes
None.
Description
The MAIL$USER_SET_INFO routine modifies specified records in the user
profile database. If you do not specify a user name, the routine
modifies the user record associated with the calling process.
|
