Z-GET06B

This document covers the following topics:


Description

Return information about an appointment, meeting, reminder or todo.

This subprogram is similar to Z-GET06A with the exception that it also returns the ISN of the calendar entry and the number of attached notes. In the case of calendar entries that occur over a period of days, you can specify that only the first record be returned. To return information about the attached notes, invoke Z-GET06C.

This subprogram returns the next appointment, meeting, reminder or todo beginning with the date and time entered in the Start-date and Start-time parameters. On the following days, all calendar entries which exceed one day are returned starting with midnight (and not with the time you specified for the first day).

The parameters Start-date, Start-time, End-date and End-time refer to the entire entry as specified online in the "Add" screen (for example, a meeting which starts at 10:00 on May 5 and ends at 16:00 on May 8).

The returned list is similar to the list which is returned with Z-GET03B. However, the list returned with Z-GET06B contains additional information: each occurrence of an entry in the list contains the start and end date/time of the whole entry.

In addition to the parameters returned by Z-GET03B, the following parameters are also returned for an appointment or meeting: Agenda, Keywords, Private-flag, Security-flags, Start-date, Start-time, End-date and End-time.

For a reminder or todo only the first 3 lines of the description are returned. The parameters Location, Agenda and Keywords are not required for reminders and todos.

For each calendar entry, the parameters Current-date, Current-start and Current-end refer to the start and end time of each day. If a calendar entry extends past midnight, Con-nect automatically splits the entry for each day.

For a private calendar entry not belonging to the specified cabinet, only the date and time are returned. The private entry has an asterisk (*) in the subject line; description, location, agenda and keywords are not returned.

The timezone is always GMT. Other timezones are not considered.

Provided that the Work-parameter is not corrupted by the calling program, this subprogram can be invoked iteratively to return successive appointments, meetings, reminders and todos.

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R   The cabinet which contains the calendar entry for which you want to return information.
Password A8 R   The password of the above cabinet.
Start-date A8 R X Format yyyymmdd. See the description above.
Start-time A8 O X Format hhmm. See the description above.
End-date A8   X Format yyyymmdd. See the description above.
End-time A8   X Format hhmm. See the description above.
Subject A20   X The subject of the calendar entry.
Description A60/1:3   X The description of the calendar entry.
Location A60   X The location of the appointment or meeting. Does not apply to a reminder or todo.
Agenda A32   X Only applies to a meeting. The name of a document which has been linked to the meeting.
Keywords A15/1:6   X Only applies to an appointment or meeting. Keywords are helpful later when you search for an object.
Private-flag A1   X If marked, the appointment or meeting is a private object. Does not apply to a reminder or todo.
Security-flags A1/1:4   X Only applies to an appointment or meeting. The security levels for Read, Modify, Copy and Print. Values 0 to 9.
Object-number N2   X 3=appointment, 16=meeting, 28=reminder, 43=todo.
Range-type A1   X 1=the entire time range, 2=separate daily entries, 3=only a starting time. Each reminder and todo has the Range-type 3.
No-occupation A1   X Blank=the calendar entry occupies time; left parenthesis=the calendar entry does not occupy time. A reminder or todo does not occupy time.
Current-date A8   X Format yyyymmdd. See the description above.
Current-start A8   X Format hhmm. See the description above.
Current-end A8   X Format hhmm. See the description above.
Calendar-ISN P10   X The ISN of the calendar entry.
Only-first A1 O   If marked, only the first record and corresponding ISN of an appointment or meeting which exceeds one day is returned. If the first record begins before Start-date, it is not returned.
Notes N2   X The number of notes attached to an appointment or meeting.
Work-parameter A40     For internal use. See The Work Parameter.

Return Codes

00 Success
02 Invalid cabinet name or - in batch mode only - locked cabinet
03 Password incorrect
41 Invalid start-date
42 Invalid start-time
77 End of list

Subprograms

Z-120
Z-122
Z-123
Z-160
Z-711
Z-1200&0

Example

0010 *
0020 *  Return information about appointment, meeting
0030 *
0040 DEFINE DATA
0050 LOCAL
0060 1 RETURN-CODE      (N2)
0070 1 CABINET          (A8)
0080 1 PASSWORD         (A8)
0090 1 START-DATE       (A8)
0100 1 START-TIME       (A8)
0110 1 END-DATE         (A8)
0120 1 END-TIME         (A8)
0130 1 SUBJECT          (A20)
0140 1 DESCRIPTION      (A60/1:3)
0150 1 LOCATION         (A60)
0160 1 AGENDA           (A32)
0170 1 KEYWORDS         (A15/1:6)
0180 1 PRIVATE-FLAG     (A1)
0190 1 SECURITY-FLAGS   (A1/1:4)
0200 1 OBJECT-NUMBER    (N2)
0210 1 RANGE-TYPE       (A1)
0220 1 NO-OCCUPATION    (A1)
0230 1 CURRENT-DATE     (A8)
0240 1 CURRENT-START    (A8)
0250 1 CURRENT-END      (A8)
0260 1 CALENDAR-ISN     (P10) /* ISN  of record is returned
0270 1 ONLY-FIRST       (A1)  /* Only the first record of a multiple-day 
0280 *                           calendar item is returned
0290 1 NOTES            (N2)  /* Number of attached notes returned
0300 1 WORK-PARAMETER   (A40)
0310 *
0320 END-DEFINE
0330 *
0340 RESET RETURN-CODE
0350 MOVE 'CABINET ' TO CABINET
0360 MOVE 'PASSWORD' TO PASSWORD
0370 MOVE '19971231' TO START-DATE
0380 MOVE '2000'     TO START-TIME
0390 MOVE 'X'        TO ONLY-FIRST
0400 *
0410 REPEAT UNTIL RETURN-CODE NE 0
0420 *
0430   CALLNAT 'Z-GET06B' RETURN-CODE
0440     CABINET
0450     PASSWORD
0460     START-DATE
0470     START-TIME
0480     END-DATE
0490     END-TIME
0500     SUBJECT
0510     DESCRIPTION(*)
0520     LOCATION
0530     AGENDA
0540     KEYWORDS(*)
0550     PRIVATE-FLAG
0560     SECURITY-FLAGS(*)
0570     OBJECT-NUMBER
0580     RANGE-TYPE
0590     NO-OCCUPATION
0600     CURRENT-DATE
0610     CURRENT-START
0620     CURRENT-END
0630     CALENDAR-ISN
0640     ONLY-FIRST
0650     NOTES
0660     WORK-PARAMETER
0670 *
0680   IF CALENDAR-ISN NE 0
0690     NEWPAGE
0700     WRITE
0710       '=' CABINET /
0720       '=' PASSWORD /
0730       '=' START-DATE
0740       '=' START-TIME /
0750       '=' END-DATE
0760       '=' END-TIME /
0770       '=' SUBJECT /
0780       '=' DESCRIPTION(1) /
0790       '=' LOCATION /
0800       '=' AGENDA /
0810       '=' KEYWORDS(1:3) /
0820       '=' KEYWORDS(4:6) /
0830       '=' PRIVATE-FLAG
0840       '=' SECURITY-FLAGS(*) /
0850       '=' OBJECT-NUMBER /
0860       '=' RANGE-TYPE /
0870       '=' NO-OCCUPATION /
0880       '=' CURRENT-DATE /
0890       '=' CURRENT-START /
0900       '=' CURRENT-END /
0910       '=' CALENDAR-ISN /
0920       '=' ONLY-FIRST  /
0930       '=' NOTES  /
0940   END-IF
0950 END-REPEAT
0960 WRITE 'Return code ' RETURN-CODE
0970 END