POSIX_TRACE_ATTR_GETCLOCKRESP(O3S)IX Programmer's MaPnOuSaIlX_TRACE_ATTR_GETCLOCKRES(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.


NNAAMMEE
       posix_trace_attr_getclockres, posix_trace_attr_getcreatetime,
       posix_trace_attr_getgenversion, posix_trace_attr_getname,
       posix_trace_attr_setname -- retrieve and set information about a trace
       stream (TTRRAACCIINNGG)

SSYYNNOOPPSSIISS
       #include <time.h>
       #include <trace.h>

       int posix_trace_attr_getclockres(const trace_attr_t *_a_t_t_r,
           struct timespec *_r_e_s_o_l_u_t_i_o_n);
       int posix_trace_attr_getcreatetime(const trace_attr_t *_a_t_t_r,
           struct timespec *_c_r_e_a_t_e_t_i_m_e);

       #include <trace.h>

       int posix_trace_attr_getgenversion(const trace_attr_t *_a_t_t_r,
           char *_g_e_n_v_e_r_s_i_o_n);
       int posix_trace_attr_getname(const trace_attr_t *_a_t_t_r,
           char *_t_r_a_c_e_n_a_m_e);
       int posix_trace_attr_setname(trace_attr_t *_a_t_t_r,
           const char *_t_r_a_c_e_n_a_m_e);

DDEESSCCRRIIPPTTIIOONN
       The _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_l_o_c_k_r_e_s() function shall copy the clock
       resolution of the clock used to generate timestamps from the _c_l_o_c_k_-
       _r_e_s_o_l_u_t_i_o_n attribute of the attributes object pointed to by the _a_t_t_r
       argument into the structure pointed to by the _r_e_s_o_l_u_t_i_o_n argument.

       The _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_r_e_a_t_e_t_i_m_e() function shall copy the trace
       stream creation time from the _c_r_e_a_t_i_o_n_-_t_i_m_e attribute of the attributes
       object pointed to by the _a_t_t_r argument into the structure pointed to by
       the _c_r_e_a_t_e_t_i_m_e argument. The _c_r_e_a_t_i_o_n_-_t_i_m_e attribute shall represent
       the time of creation of the trace stream.

       The _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_g_e_n_v_e_r_s_i_o_n() function shall copy the string
       containing version information from the _g_e_n_e_r_a_t_i_o_n_-_v_e_r_s_i_o_n attribute of
       the attributes object pointed to by the _a_t_t_r argument into the string
       pointed to by the _g_e_n_v_e_r_s_i_o_n argument. The _g_e_n_v_e_r_s_i_o_n argument shall be
       the address of a character array which can store at least
       {TRACE_NAME_MAX} characters.

       The _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_n_a_m_e() function shall copy the string
       containing the trace name from the _t_r_a_c_e_-_n_a_m_e attribute of the
       attributes object pointed to by the _a_t_t_r argument into the string
       pointed to by the _t_r_a_c_e_n_a_m_e argument. The _t_r_a_c_e_n_a_m_e argument shall be
       the address of a character array which can store at least
       {TRACE_NAME_MAX} characters.

       The _p_o_s_i_x___t_r_a_c_e___a_t_t_r___s_e_t_n_a_m_e() function shall set the name in the
       _t_r_a_c_e_-_n_a_m_e attribute of the attributes object pointed to by the _a_t_t_r
       argument, using the trace name string supplied by the _t_r_a_c_e_n_a_m_e
       argument. If the supplied string contains more than {TRACE_NAME_MAX}
       characters, the name copied into the _t_r_a_c_e_-_n_a_m_e attribute may be
       truncated to one less than the length of {TRACE_NAME_MAX} characters.
       The default value is a null string.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, these functions shall return a value of
       zero. Otherwise, they shall return the corresponding error number.

       If successful, the _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_l_o_c_k_r_e_s() function stores the
       _c_l_o_c_k_-_r_e_s_o_l_u_t_i_o_n attribute value in the object pointed to by
       _r_e_s_o_l_u_t_i_o_n.  Otherwise, the content of this object is unspecified.

       If successful, the _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_r_e_a_t_e_t_i_m_e() function stores the
       trace stream creation time in the object pointed to by _c_r_e_a_t_e_t_i_m_e.
       Otherwise, the content of this object is unspecified.

       If successful, the _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_g_e_n_v_e_r_s_i_o_n() function stores the
       trace version information in the string pointed to by _g_e_n_v_e_r_s_i_o_n.
       Otherwise, the content of this string is unspecified.

       If successful, the _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_n_a_m_e() function stores the trace
       name in the string pointed to by _t_r_a_c_e_n_a_m_e.  Otherwise, the content of
       this string is unspecified.

EERRRROORRSS
       The _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_l_o_c_k_r_e_s(), _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_r_e_a_t_e_t_i_m_e(),
       _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_g_e_n_v_e_r_s_i_o_n(), and _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_n_a_m_e()
       functions may fail if:

       EEIINNVVAALL The value specified by one of the arguments is invalid.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       The _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_l_o_c_k_r_e_s(), _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_c_r_e_a_t_e_t_i_m_e(),
       _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_g_e_n_v_e_r_s_i_o_n(), _p_o_s_i_x___t_r_a_c_e___a_t_t_r___g_e_t_n_a_m_e(), and
       _p_o_s_i_x___t_r_a_c_e___a_t_t_r___s_e_t_n_a_m_e() functions may be removed in a future
       version.

SSEEEE AALLSSOO
       _p_o_s_i_x___t_r_a_c_e___a_t_t_r___d_e_s_t_r_o_y(), _p_o_s_i_x___t_r_a_c_e___c_r_e_a_t_e(),
       _p_o_s_i_x___t_r_a_c_e___g_e_t___a_t_t_r(), _u_n_a_m_e()

       The Base Definitions volume of POSIX.1-2008, <<ttiimmee..hh>>, <<ttrraaccee..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
       -- Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, Copyright (C) 2013 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is
       POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
       event of any discrepancy between this version and the original IEEE and
       The Open Group Standard, the original IEEE and The Open Group Standard
       is the referee document. The original Standard can be obtained online
       at http://www.unix.org/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2013      POSIX_TRACE_ATTR_GETCLOCKRES(3)
