HP 3000 Manuals HP 3000 Manuals
HPDDiary
_______________________________________________________
| |
| S BA I I |
| HPDDiary (status, trans_file, op_type, [count]);|
_______________________________________________________
HPDDiary allows an application to do five things:
* Create items in the user's Diary.
* Selectively list the contents of the user's Diary.
* Selectively extract items.
* Selectively delete items.
* list freetime, that is time not occupied by appointments
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
Required, by Reference; type = BYTE_ARRAY, length = 36 bytes.
Used to return information from the Intrinsic, and to supply information
to it.
This contains the name of the Transaction File. Depending on the
op_type, the Transaction File may be used to supply a Diary item, to
supply selection information, to receive a Diary item, or to receive
selection results. The file name should be terminated with a
non-alphanumeric character other than "/" or ".". If the first character
of this parameter is an asterisk (*), HPDDiary uses the default
Transaction File specified in the Session Profile file. The name of the
default Transaction File will be returned in trans_file. If the first
character is any other non-alphabetic character (except space), the
Intrinsic creates a randomly named Transaction File to hold the details.
The randomly created name will be returned in trans_file.
op_type
Required, by Reference; type = Integer.
Used to supply information to the Intrinsic.
This defines the operation that is to be performed by this call of
HPDDiary. Valid values are:
1 Create a Diary item.
2 List user's Diary according to the selection
specified in the Transaction File. The number of
items listed is returned in count. Freetime, that
is, time not occupied by appointments, in a simple
format can also be listed.
3 Read one Diary item at a time, specified by
selector record in the Transaction File.
4 Delete one or more Diary items specified by
selector records in the Transaction File.
count
Optional, by Reference; type = INTEGER.
Used to return information from the Intrinsic.
This returns the number of items that have been listed to the Transaction
File with op_type = 2.
General Information about HPDDiary
HPDDiary can be called after a successful call to HPDUserSignon and
allows an application to:
* Create appointment or todo items, one at a time, in the current
user's Diary (items must be simple - one content part).
* List items according to selection criteria defined in the input
Transaction File, for example, by date range, subject, label and
so on.
* Extract items, one at a time, using the output of the list
operation as selectors.
* Delete one or more items using the output of the list operation as
selectors.
NOTE The extraction and deletion of items from the Diary can only be
done by selection, and not sequentially.
If a number of deletions are requested in one Transaction File and
a delete fails, the Intrinsic will continue with the remaining
deletions if possible. An error is returned in status[1].
In all operations, a tt_body_type identifier record must either be
supplied or will be returned as the first record in the file.
Selector records, if used, must start from the second record.
Transaction Records Permitted with HPDDiary
Refer to Chapter 6 for more information on the Transaction File. The
following transaction records may be used in the Transaction File
submitted to the HPDDiary Intrinsic:
1000 tt_body_type Transaction Body Type Identifier. This
record must always be provided.
5300 tt_list_diary List Diary Selector. This record must always
be provided when listing appointments, todo
items and freetime.
5400 tt_app_todo_item Appointment/Todo item/selector. This record
must be provided when reading or deleting
Diary items.
5500 tt_listfree_item List free time item
11100 tt_subject Subject
11210 tt_msg_priority Todo priority indicator. This record must be
provided when creating a todo item.
11300 tt_security Security indicator
11700 tt_app_date_time Appointment date and time specification.
This item must be provided when creating an
appointment or todo item.
11750 tt_todo_date Todo date specification
13000 tt_diary_label Label
13100 tt_diary_importance
30100 tt_start_package Start Package definition
30500 tt_content_file Content filename, filecode and subject
39000 tt_end_package End Package definition
200000 tt_referenced file Referenced file
Session Profile Options Relevant to HPDDiary
Refer to Chapter 8 for more information on the Session Profile file.
These Session Profile options can be used to change the operation of the
HPDDiary Intrinsic:
100010 sp_accept_fail Acceptable Failure indicator
100200 sp_convert Define output document format
100210 sp_convert_target Convert all documents to a specified filecode
type
100300 sp_max_size Maximum size of item to be extracted
100500 sp_time Output times in GMT (rather than local) time
100800 sp_def_transfile Default Transaction File definition
101100 Destination group for extracted items
sp_destination_group
Status Returns Specific to HPDDiary
-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
-1000 HPDUserSignon has not yet been called successfully
-1003 HP Desk is not available
-1004 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
-1009 No MPE system resource (CreateProcess Error 4)
-1010 Cannot load Intrinsics Driver program
(CreateProcess Error 16)
-1011 HP Desk and HP Desk Intrinsics software versions
are incompatible
-1100 Unable to access Transaction File (see STATUS[6]
for FS error)
-1101 Cannot create Transaction File
-1114 The Transaction File is too small (end of file
encountered)
-1115 The record size of the Transaction File is too
small
-1116 A Transaction File name must be supplied
-1200 Invalid operation type
-1202 No matching items
-1206 One or more delete transactions failed
-1900 Unexpected error
-5403 Insufficient disc space to hold message
-6000 Diary access not permitted
-6100 Missing required transaction records
-6101 Required type 5300 missing
-6102 Required type 5400 missing
-6103 Required type 11210 missing
-6104 Required type 11700 missing
-6105 Required type 11750 missing
-6106 Incompatible transaction type
-6107 Duplicate transaction type
-6150 Body type is inconsistent with the Intrinsic
-6200 Invalid field entry (refer to STATUS [3] and STATUS
[4] for more details)
-6300 Disallowed appointment clash
-6400 Bad content reference transaction