HP 3000 Manuals HP 3000 Manuals
HPDNameProbe
_____________________________________________________
| |
| S BA I |
| HPDNameProbe (status, trans_file [, op_type]);|
_____________________________________________________
HPDNameProbe allows an application to search the HP Desk directories to
verify one or more names, to extract or convert foreign address
information and to extract lists of configured countries, mailnodes and
users.
status
Required, by Reference; type = STATUS_TYPE.
Used to return information from the Intrinsic.
This gives the overall result of the search. It does not matter what it
contains when the Intrinsic is called.
trans_file
Required, by Reference; type = BYTE ARRAY, length = 36 bytes.
Used to supply information to and receive information from the Intrinsic.
This contains the name of the Transaction File to hold the search
information. The file name should be terminated by a non-alphanumeric
character other than "/" or ".". If the first character of this
parameter is an asterisk (*), the search details will be taken from the
default Transaction File as defined in the Session Profile file. The
name of the default Transaction File will be returned in the file named
in trans_file.
op_type
Optional, by Reference; type = INTEGER.
Used to supply information to the Intrinsic.
[REV BEG]
This defines the type of operation to be performed by the Intrinsic. If
it has a value of 0, HPDNameProbe verifies whether one or more of the
name/address records given in the supplied Transaction File exist in the
HP Desk directories. If it has a value of 1, HPDNameProbe returns
directory information for each unique user, depending on the selector
transaction record supplied as the second record in an otherwise empty
file.[REV END]
If op_type is not supplied, it is treated as zero.
General Information about HPDNameProbe
HPDNameProbe can be called without first signing on to a user or gateway.
However, the HP Desk user interface (USERINT) or the Gateway Intrinsics
(GATEINT) must be enabled.
HPDNameProbe is designed to allow applications to verify Distribution
Lists before they are used to construct messages. This is to allow
checks to be made that each intended recipient will receive a message.
The name matching rules that are used by the Intrinsic on input data are
described in detail in Chapter 9 . Using the verification option, one
or more names submitted in a Transaction File can be verified for
existence or for apparent duplicate entries. If a specified name/address
is found, it is overwritten with the full name/address as configured in
the directory. The result field indicates a successful probe by being
set to 52000. This is recognized by HPDGateSend and HPDUserSend so they
do not have to repeat the probe. Non-existent or apparently duplicate
names are also indicated in the result field.
NOTE Names/addresses in the Transaction File with the "do not deliver
flag" set are NOT checked for existence in the directories. Refer
to Chapter 4 of this manual for a description of the "do not
deliver" flag.
HPDNameProbe skips over surrounding transaction types if the Transaction
File is an already constructed message. In verify mode, HPDNameProbe
makes no checks on the type field of the tt_body_type transaction.
Using the directory list option, HPDNameProbe can be used to extract from
the directories, lists of countries, locations in a specified country,
sublocations on a specified location, users on a specified sublocation
and "closest match" user names/addresses for a specified name and address
where that exact name/address does not exist or appears to be a
duplicate. In these cases, HPDNameProbe expects a selector record to
appear in the second record of the file and this is overwritten with the
results.
Transaction Records Permitted with HPDNameProbe
Refer to Chapter 6 for more information on the Transaction File. Any
transaction record may be supplied to HPDNameProbe Optype 0, for example,
a complete message. However, the transaction records which the Intrinsic
will act on are shown below:
1000 yy_body_type Transaction File body type
21000 tt_from FROM name and address
21100 tt_to TO name and address
21200 tt_cc CC name and address
21300 tt_bcc BCC name and address
20050 tt_list_countries List countries
20100 tt_country Country for which location list is required
20200 tt_location Location for which sublocation list is
required
20300 tt_mailnode Sublocation for which user list is required
20400 tt_user User name/address for which "closest match"
list is required
Session Profile Options Relevant to HPDNameProbe
None.
Status Returns Specific to HPDNameProbe
-400 Cannot access first parameter
-401 Cannot access second parameter
-402 Cannot access third parameter
-500 Application does not have PH capability
-501 Application does not have DS capability
-502 User does not have SF capability
-1003 HP Desk is not available
-1004 HP Desk Intrinsics product is not installed
-1005 HP Desk Intrinsics software and message catalogue
are incompatible
-1009 No MPE system resource (CreateProcess Error 16)
-1010 Cannot load Intrinsics Driver program
(CreateProcess Error 16)
-1011 HP Desk and HP Desk Intrinsics software versions
are incompatible
-1100 Cannot access Transaction File (see STATUS[6] for
FS error)
-1110 One or more transaction records has an invalid
field
-1111 Transaction records are out of sequence, or a
transaction has an invalid type
-1112 The Transaction File is empty
-1114 The Transaction File is too small (end of file
encountered)
-1116 A Transaction Filename must be supplied
One or more names were unsuccessfully probed (refer
to status[3] and status[4] for more details)
-1200 Invalid op type
-1900 Unexpected error
-3400 Message has no recipients
-4100 Search item is invalid
-4101 Search item does not exist[REV BEG]
-6108 Invalid transaction in Transaction File (obtained
wiht op_type=1)[REV END]