TAA Tools
RTVTIMZOND      RETRIEVE TIME ZONE DESCRIPTION         TAATIMY

The  Retrieve  Time  Zone  Description  command  retrieves  information
about  a specific  time zone  description.   This  allows a  program to
process  what is  displayed by  an option  on WRKTIMZON.   The QWCRTVTZ
API is used.

A typical series of commands would be:

             DCL           &DSTSTRMTH *CHAR LEN(2)
             DCL           &DSTSTRDAY *CHAR LEN(1)
             DCL           &DSTSTRTIM *CHAR LEN(6)
              .
             RTVTIMZOND    TIMZON(xxx) DSTSTRMTH(&DSTSTRMTH)
                             DSTSTRDAY(&DSTSTRDAY)
                             DSTSTRTIM(&DSTSTRTIM)

RTVTIMZOND escape messages you can monitor for
----------------------------------------------

None.  Escape messages from based on functions will be re-sent.

Command parameters                                    *CMD
------------------

   TIMZON        The time zone  to be retrieved.   All *TIMZON  objects
                 are in QSYS.

   LCLSYSIND     The  local  system  time indicator  describes  whether
                 the  time zone  description is currently  specified in
                 the QTIMZON  system  value.   0=Not specified.    1=Is
                 specified.  This  is an optional return  variable that
                 if used must be specified as *CHAR LEN(1).

   DSTIND        The   daylight   savings   time  indicator   describes
                 whether  the  time  zone  supports  daylight   savings
                 time.  0=Does not  support.  1=Does support.   This is
                 an  optional  return variable  that  if  used must  be
                 specified as *CHAR LEN(1).

   UTCOFFSET     The  offset  from UTC  time in  minutes from  the time
                 zone  and  Coordinated  Universal  Time  (UTC).    The
                 value  is subtracted  from  local time  to obtain  the
                 UTC  time.  A  negative value indicates  the time zone
                 is west of UTC.   A positive value indicates the  time
                 zone  is east  of UTC.    This is  an optional  return
                 variable  that  if  used  must  be  specified as  *DEC
                 LEN(5 0).

   UTCHHMM       The offset from  UTC time  in hours  and minutes  from
                 the time  zone and  Coordinated Universal Time  (UTC).
                 The  value is  subtracted  from local  time  to obtain
                 the  UTC  time.   See UTCRELOFF  for  a plus  or minus
                 value.  This  is an optional  return variable that  if
                 used must be specified as *CHAR LEN(4).

   UTCRELOFF     The relative  offset as a +  or - value  from the time
                 zone  and Coordinated Universal  Time (UTC).   This is
                 an optional  return  variable  that if  used  must  be
                 specified as *CHAR LEN(1).

   STDTIMNAM     The  abbreviated name  of the  time zone.   The  value
                 may  be blank  if the  user is  not authorized  to the
                 message file  containing  the description  (stored  in
                 the  specified  message  ID).   This  is  an  optional
                 return  variable that  if  used must  be  specified as
                 *CHAR LEN(10).

   STDTIMNAMF    The  full name  of the  time zone.   The value  may be
                 blank if  the user  is not authorized  to the  message
                 file  containing   the  description  (stored   in  the
                 specified  message ID).   This  is an  optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(50).

   DSTTIMNAM     The  abbreviated name  of  the  daylight savings  time
                 zone.   The  value may  be  blank if  the user  is not
                 authorized  to   the  message   file  containing   the
                 description  (stored  in the  specified  message  ID).
                 This  is  an optional  return  variable  that if  used
                 must be specified as *CHAR LEN(10).

   DSTTIMNAMF    The  full  name  of the  daylight  savings  time zone.
                 The value may be  blank if the user is  not authorized
                 to  the   message  file  containing   the  description
                 (stored  in the  specified  message ID).   This  is an
                 optional  return  variable  that   if  used  must   be
                 specified as *CHAR LEN(50).

   STDMSG        The  message  ID  that contains  the  abbreviated  and
                 full  time zone description  for standard  time.  This
                 is an optional  return variable that  if used must  be
                 specified as *CHAR LEN(7).

   DSTMSG        The  message  ID that  contains  the  abbreviated  and
                 full  time  zone   description  for  daylight  savings
                 time.   This  is an  optional return  variable that if
                 used must be specified as *CHAR LEN(7).

   MSGF          The message  file  that contains  the  message ID  for
                 the  time  zone  description.   This  is  an  optional
                 return  variable  that if  used must  be  specified as
                 *CHAR LEN(10).

   MSGFL         The message  file library  that contains  the  message
                 file  for  the time  zone  description.   This  is  an
                 optional   return  variable  that  if   used  must  be
                 specified as *CHAR LEN(10).

   DSTSTRMTH     The month in  which daylight savings  time starts.   A
                 two     digit      value     will     be      returned
                 (01=January...12=December).    Blank  is  returned  if
                 DST  is  not supported.   This  is an  optional return
                 variable that  if  used  must be  specified  as  *CHAR
                 LEN(2).

   DSTSTRDAY     The  day  of  the  week  when  daylight  savings  time
                 starts.     A  one   digit  value   will  be  returned
                 (1=Monday...7=Sunday).  Blank  is returned  if DST  is
                 not supported.   This  is an optional  return variable
                 that if used must be specified as *CHAR LEN(1).

   DSTSTRRDAY    The  relative  day  in  which  daylight  savings  time
                 starts.    A   one  digit  value   will  be   returned
                 (1=Starts on  the  first occurrence  of the  specified
                 day...4=Starts  on   the  fourth  occurrence   of  the
                 specified  day,  L=Starts  on the  last  occurrence of
                 the specified day.   Blank is  returned if DST is  not
                 supported.   This is an optional  return variable that
                 if used must be specified as *CHAR LEN(1).

   DSTSTRTIM     The  time   of  day  (24  hour  clock)  that  daylight
                 savings time  starts.   Blank is  returned  if DST  is
                 not supported.   This is  an optional  return variable
                 that if used must be specified as *CHAR LEN(6).

   DSTENDMTH     The  month in  which daylight  savings  time ends.   A
                 two     digit     value      will     be      returned
                 (01=January...12=December).    Blank  is  returned  if
                 DST  is not  supported.   This  is an  optional return
                 variable  that  if  used must  be  specified  as *CHAR
                 LEN(2).

   DSTENDDAY     The day of the  week when daylight savings time  ends.
                 A    one     digit    value    will     be    returned
                 (1=Monday...7=Sunday).   Blank  is returned if  DST is
                 not supported.   This is  an optional return  variable
                 that if used must be specified as *CHAR LEN(1).

   DSTENDRDAY    The  relative  day  in  which  daylight  savings  time
                 ends.   A one digit value will  be returned (1=Ends on
                 the first  occurrence  of the  specified  day...4=Ends
                 on  the  fourth  occurrence  of   the  specified  day,
                 L=Ends  on the last  occurrence of the  specified day.
                 Blank  is returned if  DST is not  supported.  This is
                 an  optional return  variable  that  if used  must  be
                 specified as *CHAR LEN(1).

   DSTENDTIM     The  time  of  day   (24  hour  clock)  that  daylight
                 savings  time ends.   Blank is returned if  DST is not
                 supported.  This is  an optional return variable  that
                 if used must be specified as *CHAR LEN(6).

   DSTSHIFT      The number  of minutes that  local time  moves forward
                 when  daylight savings  time starts or  moves backward
                 when daylight savings  time ends.   A  -1 is  returned
                 if the  time zone  does not  support daylight  savings
                 time.   This is  an optional  return variable  that if
                 used must be specified as *DEC LEN(5 0).

Restrictions
------------

Because  RTVTIMZOND returns variables, the command  may only be used in
a CL program.

Prerequisites
-------------

The following TAA Tools must be on your system:

     SNDESCINF       Send escape information
     SNDESCMSG       Send escape message

Implementation
--------------

None, the tool is ready to use.

Objects used by the tool
------------------------

   Object        Type    Attribute      Src member    Src file
   ------        ----    ---------      ----------    ----------

   RTVTIMZOND    *CMD                   TAATIMY       QATTCMD
   TAATIMYC      *PGM       CLP         TAATIMYC      QATTCL
					

Added to TAA Productivity tools June 30, 2007


Home Page Up to Top