Sage-ST

Sage-ST ä
Objcalendar
Documentation


  procedure GetSingleDate
             (date    :    out string;
              Success :    out boolean);

  --*
  --  GetSingleDate - Get a single date from the calendar object.
  --
  --
  --  This procedure is an easy way to use a calendar object to get a
  --  single date from the user.  When this routine is called a calendar
  --  window opens and the user can select a date.   The selected date
  --  will be returned in the Date variable.
  --
  --  CALLING SEQUENCE -
  --
  --    GetSingleDate (Date, Success)
  --
  --  ENTRY -
  --
  --  EXIT -
  --
  --    Date : string
  --      If a date is passed in the calendar will start at this date.
  --       When the routine returns this will be the date that the user
  --       has selected or the same date if the user did not select.
  --       NOTE - coming in or out this date should be in Date0 format.
  --
  --    Success : boolean
  --      True - a date was selected.
  --      False - the user did not select a date.
  --


  procedure GetDateRange
             (RangeStart :    out string;
              RangeEnd   :    out string;
              Success    :    out boolean);

  --*
  --  GetDateRange - Get a range of dates from the calendar object.
  --
  --
  --  This procedure is an easy way to use a calendar object to get a
  --  range of dates from the user.  When this routine is called a calendar
  --  window opens and the user can select the range.   The selected dates
  --  will be returned in the RangeStart and RangeEnd variables.
  --
  --  CALLING SEQUENCE -
  --
  --    GetDateRange (RangeStart, RangeEnd, Success)
  --
  --  ENTRY -
  --
  --    None
  --      N/A
  --
  --  EXIT -
  --
  --    RangeStart : string
  --      If a date is passed in the calendar will start at this date.
  --      When the routine returns this will be the range start date that
  --      the user has selected or the same date if the user did not select.
  --      NOTE - coming in or out this date should be in Date0 format.
  --
  --    RangeEnd : string
  --      The date that the user has selected to end the range.
  --      NOTE - coming in or out this date should be in Date0 format.
  --
  --    Success : boolean
  --      True - a range was selected.
  --      False - the user did not select a range.
  --