VMS Help
RTL Routines, DNS$
*Conan The Librarian (sorry for the slow response - running on an old VAX)
|
|
1 - DNS$APPEND_SIMPLENAME_TO_RIGHT
|
The Append a Simple Name to the End of a Full Name routine adds an
opaque simple name to the end of an opaque full name to create a
new full name.
Format
DNS$APPEND_SIMPLENAME_TO_RIGHT
fullname ,simplename ,resulting-fullname ,resulting-length
Arguments
fullname
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The opaque full name gaining a new simple name. The fullname
argument is the address of a descriptor pointing to the opaque
full name that is to be extended.
simplename
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The opaque simple name that is appended. The simplename argument
is the address of a descriptor pointing to an opaque simple name
that is to be appended to the full name, thus creating a new full
name.
resulting-fullname
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The new full name. The resulting-fullname argument is the address
of a descriptor that points to the buffer that receives the new
full name. This buffer can be the same as the buffer referred
to by the fullname argument; however, the descriptors must be
separate.
resulting-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the new full name. The resulting-length argument
is the address of a word that receives the length of the new full
name found in resulting-fullname.
The Compare Full Names routine compares two opaque full names and
returns the result.
Format
DNS$COMPARE_FULLNAME fullname1 ,fullname2
Arguments
fullname1
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
One opaque full name. The fullname1 argument is the address of a
descriptor pointing to an opaque full name.
fullname2
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
One opaque full name. The fullname2 argument is the address of a
descriptor pointing to an opaque full name.
3 - DNS$COMPARE_SIMPLENAME
|
The Compare Two Simple Names routine compares two simple names,
without considering case.
Format
DNS$COMPARE_SIMPLENAME simplename1 ,simplename2
Arguments
simplename1
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
An opaque simple name. The simplename1 argument is the address of
a descriptor pointing to the first simple name.
simplename2
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
An opaque simple name. The simplename2 argument is the address of
a descriptor pointing to the second simple name.
The Join Two Names routine joins two opaque full names to form a
new full name.
Format
DNS$CONCATENATE_NAME
fullname1 ,fullname2 ,resulting-fullname ,resulting-length
Arguments
fullname1
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The opaque full name to be joined. The fullname1 argument is the
address of a descriptor pointing to the opaque full name.
fullname2
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The opaque full name appended to fullname1. The fullname2 argument
is the address of a descriptor pointing to the full name to be
appended.
resulting-fullname
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The buffer where the new full name will be written. The resulting-
fullname argument is the address of a descriptor pointing to the
buffer. This buffer can be the same as the buffer referred to by
the fullname1 argument; however, the descriptors must be separate.
resulting-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the new full name. The resulting-length argument
is the address of a word that receives the length of the new full
name found in resulting-fullname.
5 - DNS$COUNT_SIMPLENAMES
|
The Count the Simple Names in a Full Name routine counts the
number of simple names contained in an opaque full name.
Format
DNS$COUNT_SIMPLENAMES fullname ,count
Arguments
fullname
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The full name to be counted. The fullname argument is the address
of a descriptor pointing to the full name that is to be examined
for the simple names it contains.
count
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The number of simple names found in the full name. The count
argument is the address of a word that receives the number of
simple names.
6 - DNS$CVT_DNSADDRESS_TO_BINARY
|
The Convert a DNS Address to a Phase IV Binary Address routine
takes a DNS address and returns the DECnet Phase IV node address.
Format
DNS$CVT_DNSADDRESS_TO_BINARY dnsaddress ,binary
Arguments
dnsaddress
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The DNS address. The dnsaddress argument is the address of a
descriptor pointing to the DNS address.
binary
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The DECnet Phase IV address found in the DNS address structure.
The binary argument is the address of a word containing the 16-bit
Phase IV address of the node.
7 - DNS$CVT_DNSADDRESS_TO_NODENAME
|
The Convert a DNS Address to a Node Name routine takes a DNS
address and returns a DECnet Phase IV node name.
Format
DNS$CVT_DNSADDRESS_TO_NODENAME
dnsaddress ,nodename ,resulting-length
Arguments
dnsaddress
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The DNS address. The dnsaddress argument is the address of a
descriptor pointing to the DNS address.
nodename
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The DECnet Phase IV node name. The nodename argument is the
address of a descriptor pointing to the Phase IV node name. The
memory buffer referenced by the DSC$A_POINTER portion of this
descriptor must be large enough to contain the entire Phase IV
node name string, which is up to six bytes long.
resulting-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the node name (in bytes) after conversion. The
resulting-length argument is a word containing the length of the
node name (in bytes) after conversion.
8 - DNS$CVT_NODENAME_TO_DNSADDRESS
|
The Convert a Node Name to a DNS Address routine takes a DECnet
Phase IV node name and returns a DNS address.
Format
DNS$CVT_NODENAME_TO_DNSADDRESS
nodename ,dnsaddress ,resulting-length
Arguments
nodename
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The DECnet Phase IV node name. The nodename argument is the
address of a descriptor pointing to the node name. This routine
creates a DNS address containing the node address of the given
Phase IV node name.
dnsaddress
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The address of a buffer containing the DNS address. The dnsaddress
argument is the address of a descriptor pointing to the buffer
address.
resulting-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the DNS address after conversion. The resulting-
length argument is a word containing the length of the address.
9 - DNS$CVT_TO_USERNAME_STRING
|
The Convert an Opaque User Name to a String routine converts an
opaque DECnet Phase IV user name into a username string.
Format
DNS$CVT_TO_USERNAME_STRING
fullname ,username ,resulting-length
Arguments
fullname
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The opaque full name for the DECnet Phase IV user name. The
fullname argument is the address of a descriptor pointing to the
name.
username
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The name converted to DECnet Phase IV format (node::user). The
username argument is the address of a descriptor pointing to a
buffer containing the converted name.
resulting-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the converted user name. The resulting-length
argument is the address of a word containing the length.
10 - DNS$PARSE_USERNAME_STRING
|
The Convert a User Name from String to Opaque routine converts a
DECnet Phase IV user name to an opaque full name.
Format
DNS$PARSE_USERNAME_STRING
user-string ,phase4-name ,resulting-length
[,next-character-pointer]
Arguments
user-string
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The name string to convert. The user-string argument is the
address of a descriptor pointing to the DECnet Phase IV username
string, which is in the format node::user.
phase4-name
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The opaque full name resulting from conversion. The phase4-name
argument is the address of a descriptor pointing to the buffer
that is to contain an opaque full name representing a user name on
a Phase IV node.
resulting-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the opaque full name. The resulting-length argument
is the address of a word holding the length of the name returned
in phase4-name.
next-character-pointer
OpenVMS Usage: address
type: address
access: write only
mechanism: by reference
The character following the DNS name extracted from user-string.
The next-character-pointer argument is the address of the
character following the DNS name. When you use this argument,
DNS$PARSE_USERNAME_STRING returns DNS$_INVALIDNAME when it
encounters an invalid name. In such a case, next-character-pointer
points to the first character in the name that is invalid.
11 - DNS$REMOVE_FIRST_SET_VALUE
|
The Remove a Value from a Set routine extracts the first value
from a set and returns the value with its creation time-stamping
(UID).
Format
DNS$REMOVE_FIRST_SET_VALUE
set [,value] [,value-length] [,uid] [,uid-length] [,newset]
[,newset-length]
Arguments
set
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The set from which the value is extracted. The set argument is the
address of a descriptor pointing to the set.
value
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The value extracted from the set. The value argument is the
address of a descriptor pointing to a buffer containing the value.
value-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the value. The value-length argument is the address
of a word holding the length of the value placed in value.
uid
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The buffer holding the creation time-stamping (UID) of the
extracted value. The uid argument is the address of a descriptor
pointing to the buffer.
uid-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the UID placed in uid. The uid-length argument is
the address of a word holding the length.
newset
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The opaque set without the first value. The newset argument is the
address of a descriptor pointing to a buffer containing that set.
The buffer can be the same as the one given in the set argument.
newset-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the new set copied to the newset buffer. The newset-
length argument is the address of a word that receives the length.
12 - DNS$REMOVE_LEFT_SIMPLENAME
|
The Remove the Simple Name on the Left from the Full Name routine
removes the leftmost simple name from an opaque full name. It
returns both the simple name stripped and the new full name that
results from the operation.
Format
DNS$REMOVE_LEFT_SIMPLENAME
fullname [,resulting-fullname] [,resulting-fullname-length]
[,resulting-simplename] [,resulting-simplename-length]
Arguments
fullname
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The opaque full name to strip. The fullname argument is the
address of a descriptor pointing to the opaque full name to strip.
If the full name does not contain any simple names, the routine
returns a value of 0 in cond_value.
resulting-fullname
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The opaque full name resulting from the operation. The resulting-
fullname argument is the address of a descriptor pointing to the
buffer containing the resulting opaque full name. This buffer can
be the same as the buffer referred to by the fullname argument;
however, the descriptors must be separate.
resulting-fullname-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the full name that is returned. The resulting-
fullname-length argument is the address of a word receiving the
length of the full name returned in resulting-fullname.
resulting-simplename
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The simple name stripped from fullname. The resulting-simplename
argument is the address of a descriptor pointing to the buffer
containing the opaque simple name that was stripped.
resulting-simplename-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the simple name. The resulting-simplename-length
argument is the address of a word that receives the length of the
simple name returned in resulting-simplename.
13 - DNS$REMOVE_RIGHT_SIMPLENAME
|
The Remove the Simple Name on the Right from the Full Name routine
removes the rightmost simple name from an opaque full name. It
returns both the simple name stripped and the new full name that
results from the operation.
Format
DNS$REMOVE_RIGHT_SIMPLENAME
fullname [,resulting-fullname] [,resulting-fullname-length]
[,resulting-simplename] [,resulting-simplename-length]
Arguments
fullname
OpenVMS Usage: char_string
type: character string
access: read only
mechanism: by descriptor
The opaque full name to strip. The fullname argument is the
address of a descriptor pointing to the opaque full name to strip.
When the opaque full name does not contain any simple names, the
routine returns a value of 0 in cond_value.
resulting-fullname
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
The opaque full name resulting from the operation. The resulting-
fullname argument is the address of a descriptor pointing to a
buffer containing the resulting opaque full name. This buffer can
be the same as the buffer referred to by the fullname argument;
however, the descriptors must be separate.
resulting-fullname-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the full name returned in resulting-fullname.
The resulting-fullname-length argument is the address of a word
that receives the length of the full name returned in resulting-
fullname.
resulting-simplename
OpenVMS Usage: char_string
type: character string
access: write only
mechanism: by descriptor
A buffer containing the opaque simple name stripped from fullname.
The resulting-simplename argument is the address of a descriptor
pointing to the buffer.
resulting-simplename-length
OpenVMS Usage: word_unsigned
type: word (unsigned)
access: write only
mechanism: by reference
The length of the simple name. The resulting-simplename-length
argument is the address of a word receiving the length of the
simple name returned in resulting-simplename.
[legal]
[privacy]
[GNU]
[policy]
[netiquette]
[sponsors]
[FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.