.. highlightlang:: us

.. index:: LayerSetAxisDateFormat

.. _layersetaxisdateformat:

LayerSetAxisDateFormat
======================

.. us.tag  LayerSetAxisDateFormat NOTREADYENGLISH LayerSet

:ref:`LayerSetAxisDateFormat` sets the date/time format for the axis label.

.. function::  bool = LayerSetAxisDateFormat(hLayer, ssXYZ, ssFormat)

.. us.return

**Return Value**

If the function succeeds, the return value is TRUE (1); otherwise it is FALSE (0).

.. us.params

**Parameters**

.. uparam:: hLayer

   Identifies the layer.

.. uparam:: ssXYZ

   *ssXYZ* is ``"X"`` for the x-axis, ``"Y"`` for the y-axis and ``"Z"`` for the
   z-axis.

.. uparam:: ssFormat

   *ssFormat* is a scalar string. The formatting codes for a format string are
   listed below:

   .. list-table::
      :header-rows: 1

      * - Value
        - Meaning
      * - %a
        - Abbreviated weekday name
      * - %A
        - Full weekday name
      * - %B
        - Full month name
      * - %c
        - Date and time representation appropriate for locale
      * - %d
        - Day of month as decimal number (01 - 31)
      * - %H
        - Hour in 24-hour format (00 - 23)
      * - %I
        - Hour in 12-hour format (01 - 12)
      * - %j
        - Day of year as decimal number (001 - 366)
      * - %m
        - Month as decimal number (01 - 12)
      * - %M
        - Minute as decimal number (00 - 59)
      * - %p
        - Current locale's A.M./P.M. indicator for 12-hour clock
      * - %S
        - Second as decimal number (00 - 59)
      * - %U
        - Week of year as decimal number, with Sunday as first day of week (00 - 51)
      * - %w
        - Weekday as decimal number (0 - 6; Sunday is 0)
      * - %W
        - Week of year as decimal number, with Monday as first day of week (00 - 51)
      * - %x
        - Date representation for current locale
      * - %X
        - Time representation for current locale
      * - %y
        - Year without century, as decimal number (00 - 99)
      * - %Y
        - Year with century, as decimal number
      * - %z, %Z
        - Time-zone name or abbreviation
      * - %%
        - Percent sign
      * - #
        - Remove leading zeros (if any) Example: %#m

.. seealso::
   :ref:`overview-diagrams`,
   :ref:`LayerCreate`,
   :ref:`LayerGetAxisDateFormat`,
   :ref:`LayerSetAxisMinMaxDelta`,
   :ref:`LayerSetAxisScale`

:sub:`id-160875`