Z-INVX

This document covers the following topics:


Description

Return information about an invitation to a meeting or a cancelation message that is stored in the Inbasket file Invitations.

Statistics information that is usually invoked via the calendar (when issuing the INFO command with the meeting) is also returned. The number of pending invitations can be calculated by subtracting the numbers that are returned for Accepted-number, Declined-number and Stopped-number from the number returned for Read-by-number.

The time zone is always GMT. Other timezones are not considered.

Parameters

Parameter Format In Out Remarks
Return-code N2 O X Input -1: no ET.
Cabinet A8 R   The cabinet which contains the invitation or cancelation message.
Password A8 R   The password of the above cabinet.
Folder-sequence N1 O   The sequence in which the folder or file contents is to be returned. 1=ascending by date, 2=descending by date. Default: 1.
Start-value A32 O   Date (yyyymmdd) for ascending or descending date order.
Number N2 O   The maximum number of objects that are returned with each call. When you do not specify a value, or when you specify a value greater than 20, the default value 20 is used.
Invitation-table (20)
  Subject A20   X The subject of the invitation or cancelation message.
  Version N5   X The version number of the invitation or cancelation message.
  Invitation-type N1   X 1=invitation, 2=modified invitation, 3=cancelation message.
  Invitation-ISN P10   X The ISN of the invitation or cancelation message.
  Agenda A1   X If marked, an agenda has been attached to the invitation or cancelation message.
  Mailed-date A8   X The date when the originator has sent the invitation or cancelation message. Format yyyymmdd.
  Mailed-time A4   X The time when the originator has sent the invitation or cancelation message. Format hhmm.
  Start-date A8   X The starting date of the meeting. Format yyyymmdd.
  Start-time A4   X The starting time of the meeting. Format hhmm.
  End-date A8   X The ending date of the meeting. Format yyyymmdd.
  End-time A4   X The ending time of the meeting. Format hhmm.
  Separate-daily-entries A1   X If marked, the meeting occupies only the specified time range for each day. If not marked, the whole time range starting with the Start-time of the first day and ending with the End-time of the last day is reserved.
  Sent-by A20   X The name of the originator.
  Sent-to-number N7   X The number of attendees to which the invitation or cancelation message has been sent.
  Read-by-number N7   X The number of attendees who have already read the invitation or cancelation message.
  Accepted-number N7   X The number of attendees who accepted the meeting.
  Declined-number N7   X The number of attendees who declined the meeting but still receive any modifications made to the invitation.
  Stopped-number N7   X The number of attendees who declined the meeting and do not receive any modifications made to the invitation.
Work-parameter A49     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
24 Security violation
77 End of list

Subprograms

Z-DIS13A

See also the list of subprograms for Z-DIS13A.

Example

* Get information about an invitation
*
DEFINE DATA
LOCAL
*
1 RETURN-CODE              (N2)
1 CABINET                  (A8)
1 PASSWORD                 (A8)
1 FOLDER-SEQUENCE          (N1)
1 START-VALUE              (A32)
1 REDEFINE START-VALUE
  2 START-READ-DATE        (A8)
1 NUMBER                   (N2)
1 INVITATION-TABLE         (20)
  2 SUBJECT                (A20)
  2 VERSION                (N5)
  2 INVITATION-TYPE        (N1)
  2 INVITATION-ISN         (P10)
  2 AGENDA                 (A1)
  2 MAILED-DATE            (A8)
  2 MAILED-TIME            (A4)
  2 START-DATE             (A8)
  2 START-TIME             (A4)
  2 END-DATE               (A8)
  2 END-TIME               (A4)
  2 SEPARATE-DAILY-ENTRIES (A1)
  2 SENT-BY                (A20)
  2 SENT-TO-NUMBER         (N7)
  2 READ-BY-NUMBER         (N7)
  2 ACCEPTED-NUMBER        (N7)
  2 DECLINED-NUMBER        (N7)
  2 STOPPED-NUMBER         (N7)
1 WORK                     (A49)
1 #INX                     (N2)
END-DEFINE
*
RESET WORK
MOVE 'Cabinet'  TO CABINET
MOVE 'Password' TO PASSWORD
MOVE 1          TO FOLDER-SEQUENCE
MOVE ' '        TO START-VALUE
MOVE 12         TO NUMBER
*
REPEAT UNTIL RETURN-CODE NE 0
  RESET INVITATION-TABLE(*)
  CALLNAT 'Z-INVX'
    RETURN-CODE
    CABINET
    PASSWORD
    FOLDER-SEQUENCE
    START-VALUE
    NUMBER
    INVITATION-TABLE(*)
    WORK
*
  IF INVITATION-ISN(1) NE 0
    FOR #INX 1 TO NUMBER
      IF INVITATION-ISN(#INX) NE 0
        NEWPAGE
        WRITE '(' #INX ')' /
          'INVITATION-ISN   :'   INVITATION-ISN(#INX)   /
          'SUBJECT          :'   SUBJECT(#INX)(AL=20)   /
          'VERSION          :'   VERSION(#INX)          /
          'INVITATATION-TYPE:'   TYPE-OF-INVITATION(#INX) /
          'AGENDA           :'   AGENDA (#INX)          /
          'MAILED-DATE      :'   MAILED-DATE (#INX)     /
          'MAILED-TIME      :'   MAILED-TIME (#INX)     /
          'START-DATE       :'   START-DATE (#INX)      /
          'START-TIME       :'   START-TIME (#INX)      /
          'END-DATE         :'   END-DATE (#INX)        /
          'END-TIME         :'   END-TIME (#INX)        /
          'DAILY-ENTRIES    :'   SEPARATE-DAILY-ENTRIES (#INX) /
          'SENT-BY          :'   SENT-BY (#INX)         /
          'SENT-TO-NUMBER   :'   SENT-TO-NUMBER (#INX)  /
          'READ-BY-NUMBER   :'   READ-BY-NUMBER (#INX)  /
          'ACCEPTED-NUMBER  :'   ACCEPTED-NUMBER (#INX) /
          'DECLINED-NUMBER  :'   DECLINED-NUMBER (#INX) /
          'STOPPED-NUMBER   :'   STOPPED-NUMBER (#INX) /
      END-IF
    END-FOR
  ELSE
    WRITE 'No items found' /
  END-IF
END-REPEAT
*
IF RETURN-CODE NE 0
  WRITE / 'Return code' RETURN-CODE
ELSE
  WRITE / 'Return status OK'
END-IF
*
END