GetAxisTimeFormat

int GetAxisTimeFormat (int panel, int control, int axis, int format, const char formatString[]);

Purpose

Gets the format string for a graph, digital graph (x-axis only), or strip chart axis that is in absolute time or relative time format.

The format string supports the same format specifiers as the strftime function with the %nf and @ extensions.

Note  The @ extension is valid only for the relative time format.

Parameters

Input
Name Type Description
panelHandle integer Specifier for a particular panel that is currently in memory. You obtain this handle from LoadPanel, NewPanel, or DuplicatePanel.
controlID integer The defined constant, located in the .uir header file, that you assigned to the control in the User Interface Editor, or the ID returned by NewCtrl or DuplicateCtrl.
axis integer The axis from which you want to get the format string. For graphs, you must specify one of the following values: VAL_BOTTOM_XAXIS, VAL_TOP_XAXIS, VAL_LEFT_YAXIS, or VAL_RIGHT_YAXIS. For strip charts, you must specify VAL_LEFT_YAXIS or VAL_BOTTOM_XAXIS. For digital graphs, you must specify VAL_BOTTOM_XAXIS.

format integer The time format for which you want to get the format string. You must specify either VAL_ABSOLUTE_TIME_FORMAT or VAL_RELATIVE_TIME_FORMAT.
bufferSize integer The maximum number of characters, including a terminating NUL character, to be written into outputBuffer.

Output
Name Type Description
outputBuffer string The destination buffer for the format string.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success