HP 3000 Manuals HP 3000 Manuals
HPDDeleteMsg
___________________________________________
| |
| S BA |
| HPDDeleteMsg (status, [trans_file]);|
___________________________________________
HPDDeleteMsg allows an application to delete the last message accessed by
the HPDUserReceive or HPDGateReceive Intrinsics. However, if you supply
a Transaction File containing a range of messages in the In Tray or
Pending Tray this range will be deleted.
status
Required, by Reference; type = STATUS_TYPE
Used to return information from the Intrinsic.
This gives the overall result of the operation. It does not matter what
it contains when the Intrinsic is called.
trans_file
Optional, by Reference; type = BYTE ARRAY, length = 36 bytes.
Used to supply information to the Intrinsic.
This contains the name of the Transaction File which holds the details of
the messages that are to be deleted from either the $intray; or Pending
Tray. 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 details of the messages to be deleted are taken from
the default transaction file as defined in the Session Profile file.
General Information about HPDDeleteMsg
If you do not supply a Transaction File, HPDDeleteMsg allows an
application to delete the last message successfully accessed by
HPDGateReceive (see Chapter 5 ) from a mailnode queue or by
HPDUserReceive (see Chapter 2 ) from either the In Tray or Pending
Tray. Therefore, the application must have already signed on in order to
use this Intrinsic.
HPDDeleteMsg may also be used to selectively delete messages from either
a user's In Tray or Pending Tray. This may be achieved by supplying a
Transaction File containing one or more suitable In Tray or Pending Tray
item transactions (types 5100 and 5200) as produced by the relevant list
function of the HPDUtility Intrinsic.
Note that type 5100 and 5200 transactions should be copied without
alteration into the Transaction File supplied to HPDDeleteMsg. This is
necessary because these transactions contain reserved fields that are
used internally.
If a call to another Intrinsic is made after one to HPDUserReceive or
HPDGateReceive and before HPDDeleteMsg, the message which was received
last remains the current one. Any processing or actions will be
performed on this message.
If a number of deletions are requested in one Transaction File and a
delete fails, the Intrinsic continues with the remaining deletions, if
possible. An error is returned in status[1].
Transaction Records Permitted with HPDDeleteMsg
Refer to Chapter 6 for more information on the Transaction File. The
following transaction records may be used in the Transaction File
submitted to HPDDeleteMsg:
1000 tt_body_type Transaction File body type Identifier. This
transaction record must always be provided.
5100 tt_intray_item In Tray item. If this transaction record is
not provided a 5200 record must be.
5200 tt_pendingtray_item Pending Tray item. If this transaction
record is not provided a 5100 record must be.
Session Profile Options Relevant to HPDDeleteMsg
Refer to Chapter 8 for more information on the Session Profile file.
These Session Profile options can be used to change the operation of
HPDDeleteMsg:
100800 sp_def_transfile Use default Transaction File
Status Returns Specific to HPDDeleteMsg
-400 Cannot access first parameter
-401 Cannot access second parameter
-500 Application does not have PH capability
-501 Application does not have DS capability
-502 User does not have SF capability
-1002 Application is not signed on as a user or 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
-1007 HP Desk User Intrinsics sessions are disabled
-1008 HP Desk Gateway Intrinsics sessions are disabled
-1009 No MPE system resource (CreateProcess Error 4)
-1010 Cannot load Intrinsics Driver program
(CreateProcess Error 16)
-1011 HP Desk and HP Desk Intrinsics versions are
incompatible
-1110 One or more transaction records has an invalid
field
-1111 Transaction records are out of sequence, or a
transaction has an invalid type
-1206 One or more delete transactions failed
-1900 Unexpected error
-7000 There is no current message to delete
-7001 Selected message does not exist