HP 3000 Manuals HP 3000 Manuals
HPDGateSignon
___________________________________________________________________________________
| |
| S BA BA BA |
| HPDGateSignon (status, gateway_name[, gateway_password] [,session_profile]);|
___________________________________________________________________________________
[REV BEG]
HPDGateSignon allows an application to sign on to an HP Desk gateway. A
gateway name and password must be provided if set.[REV END]
status
Required, by Reference; type = STATUS_TYPE
Used to return information from the Intrinsic.
This gives the result of the attempted sign on. It does not matter what
it contains when the Intrinsic is called.
gateway_name
Required, by Reference; type = BYTE ARRAY, length = 8 bytes.
Used to supply information to the Intrinsic.
This contains the HP Desk gateway to be used for signing on. It should
be space filled to 8 bytes.
gateway_password
Optional, by Reference; type = BYTE ARRAY, length = 8 bytes.
Used to supply information to the Intrinsic.
This contains the password of the gateway. This parameter must be at
least 8 bytes long, space filled as necessary. It can be omitted if the
gateway has not been configured with a password.
session_profile
Optional, by Reference; type = BYTE ARRAY, length = 36 bytes.
Used to supply information to the Intrinsic.
This contains the name of the Session Profile file to be used. If
required, the file name should be specified with a terminating,
non-alphanumeric character other than "." or "/". If this parameter is
not supplied, the default Session Profile options, as specified in the
default Session Profile file, will be used.
General Information about HPDGateSignon
HPDGateSignon must be called by an application before it can execute the
Intrinsics HPDGateSend and HPDGateReceive, and most Supporting
Intrinsics. A second call to HPDGateSignon results in automatic signing
off from the first gateway if this has not already been done.
The Gateway Intrinsics require a Default User to be configured in the
database. This is done from MAILCONFIG's Local Control Data menu.
HPDGateSignon checks that a valid Default User is configured and returns
an error if not.
If a gateway password is specified in the Intrinsic call, the application
must be careful that security is not compromised. If the application
stores passwords, it should ensure that they are safeguarded in some way.
HPDGateSignon defines the gateway the application will work on behalf of
for the transmission and receipt of messages. All messages, for all
nodes routed through the named gateway, are available to the
HPDGateReceive Intrinsic and so it could receive mail destined for a
number of mailnodes.
More than one application can be logged on to a gateway at any time.
Internal locking mechanisms guard against interference if, for example,
both are extracting messages from the database. However, there is no
point in having more HPDGateReceive applications logged on to a gateway
than there are nodes routed through the gateway. This is because mail
queued on a node can only be picked up through HPDGateReceive by one
application at a time.
The usual HP Desk reporting of a successful sign on is done to the system
operator's terminal and to the HP Desk Statistics file.
NOTE See Chapter 9 for installation information for the Gateway
Intrinsics. It is essential that the action described in Chapter 9
is followed, otherwise neither the Gateway Intrinsics
themselves nor the Intrinsics Gateway screens in MAILCONFIG will
work properly.
Session Profile Options Relevant to HPDGateSignon
Refer to Chapter 8 for more information on the Session Profile file.
These Session Profile options can be used to change the operation of
HPDGateSignon:
100010 sp_accept_fail Acceptable Failure Indicator
100100 sp_extra_user_info Accept specified explicit and/or alias
foreign addresses
100200 sp_convert Define output format of content
100210 sp_convert_target Convert all documents to a specified filecode
type
100300 sp_max_size Maximum size of message to be extracted
100500 sp_time Accept times in GMT (rather than local)
format
100600 sp_message_wait Wait for arrival of messages (rather than
return control to calling application
immediately)
100800 sp_def_transfile Use default Transaction File
100900 sp_name_addr_checks Alter name/address checking
101100 Destination group for received files
sp_destination_group
Status Returns Specific to HPDGateSignon
-400 Cannot access first parameter
-401 Cannot access second parameter
-402 Cannot access third parameter
-403 Cannot access fourth parameter
-500 Application does not have PH capability
-501 Application does not have DS capability
-502 User does not have SF capability
-1001 Application is not signed on as a gateway
-1003 HP Desk is not available
-1004 The HP Desk Intrinsics product is not installed
-1005 HP Desk Intrinsics software and message catalogue
are incompatible
-1008 HP Desk Gateway Intrinsics sessions are disabled
-1009 No MPE system resource (CreateProcess Error 4)
-1010 Cannot load Intrinsics Driver process
(CreateProcess Error 16)
-1011 HP Desk Intrinsics software and message catalogue
are incompatible
-1111 Transaction records are out of sequence, or a
transaction has an invalid type
-1900 Unexpected error
-2200 Gateway Name not valid or badly formed
-2201 Gateway name must be supplied
-2202 Gateway is not configured
-2203 Gateway is not an Intrinsics gateway
-2204 A Default User must be configured on the database
-2400 Password is incorrect