home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 1 / FishNMoreVol1.bin / more / programming / arpprog / newdocs / stamptostr < prev    next >
Text File  |  1988-02-22  |  2KB  |  133 lines
  1.  
  2.  
  3.  
  4.      StamptoStr(33.4)      ARP Programmers Manual      StamptoStr(33.4)
  5.  
  6.  
  7.  
  8.      NAME
  9.       StamptoStr - convert DateStamp portion of DateTime structure
  10.           to string.
  11.  
  12.      SYNOPSIS
  13.       error    = StamptoStr(DateTime)
  14.         d0            A0
  15.  
  16.      FUNCTION
  17.       StamptoStr converts an AmigaDOS DateStamp to a human
  18.       readable ASCII string    as requested by    your settings in the
  19.       DateTime structure.
  20.  
  21.      INPUTS
  22.       DateTime - a pointer to an initialized DateTime structure.
  23.  
  24.       The DateTime structure should    be initialized as follows:
  25.  
  26.       dat_Stamp - a    copy of    the datestamp you wish to convert to
  27.           ascii.
  28.  
  29.       dat_Format - a format    byte which specifies the format    of the
  30.           dat_StrDate.    This can be any    of the following
  31.           (note: If value used is something other than those
  32.           below, the default of    FORMAT_DOS is used):
  33.  
  34.           FORMAT_DOS:      AmigaDOS format (dd-mmm-yy).
  35.  
  36.           FORMAT_INT:      International    format (yy-mmm-dd).
  37.  
  38.           FORMAT_USA:      American format (mm-dd-yy).
  39.  
  40.           FORMAT_CDN:      Canadian format (dd-mm-yy).
  41.  
  42.       dat_Flags - a    flags byte.  The only flag which affects this
  43.           function is:
  44.  
  45.           DTB_SUBST:      If set, a string such    as Today,
  46.                   Monday, etc.,    will be    used instead
  47.                   of the dat_Format specification if
  48.                   possible.
  49.  
  50.       dat_StrDay - pointer to a buffer to receive the day of the
  51.           week string.    (Monday, Tuesday, etc.). If null, this
  52.           string will not be generated.
  53.  
  54.       dat_StrDate -    pointer    to a buffer to receive the date
  55.           string, in the format    requested by dat_Format,
  56.           subject to possible modifications by DTB_SUBST.  If
  57.           null,    this string will not be    generated.
  58.  
  59.       dat_StrTime -    pointer    to a buffer to receive the time    of day
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 2/22/88)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      StamptoStr(33.4)      ARP Programmers Manual      StamptoStr(33.4)
  71.  
  72.  
  73.  
  74.           string. If NULL, this    will not be generated.
  75.  
  76.      RESULT
  77.       error    - a non-zero return indicates that the DateStamp was
  78.           invalid, and could not be converted.    Zero indicates
  79.           that everything went according to plan.
  80.  
  81.      BUGS
  82.       None known
  83.  
  84.      SEE ALSO
  85.       StrtoStamp
  86.  
  87.      AUTHOR
  88.       KRS
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                         (printed 2/22/88)
  130.  
  131.  
  132.  
  133.