FGETPOS(3)                 POSIX Programmer's Manual                FGETPOS(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
       fgetpos -- get current file position information

SSYYNNOOPPSSIISS
       #include <stdio.h>

       int fgetpos(FILE *restrict _s_t_r_e_a_m, fpos_t *restrict _p_o_s);

DDEESSCCRRIIPPTTIIOONN
       The functionality described on this reference page is aligned with the
       ISO C standard. Any conflict between the requirements described here
       and the ISO C standard is unintentional. This volume of POSIX.1-2017
       defers to the ISO C standard.

       The _f_g_e_t_p_o_s() function shall store the current values of the parse
       state (if any) and file position indicator for the stream pointed to by
       _s_t_r_e_a_m in the object pointed to by _p_o_s.  The value stored contains
       unspecified information usable by _f_s_e_t_p_o_s() for repositioning the
       stream to its position at the time of the call to _f_g_e_t_p_o_s().

       The _f_g_e_t_p_o_s() function shall not change the setting of _e_r_r_n_o if
       successful.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _f_g_e_t_p_o_s() shall return 0; otherwise, it
       shall return a non-zero value and set _e_r_r_n_o to indicate the error.

EERRRROORRSS
       The _f_g_e_t_p_o_s() function shall fail if:

       EEBBAADDFF  The file descriptor underlying _s_t_r_e_a_m is not valid.

       EEOOVVEERRFFLLOOWW
              The current value of the file position cannot be represented
              correctly in an object of type ffppooss__tt.

       EESSPPIIPPEE The file descriptor underlying _s_t_r_e_a_m is associated with a pipe,
              FIFO, or socket.

       _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
       None.

SSEEEE AALLSSOO
       _S_e_c_t_i_o_n _2_._5, _S_t_a_n_d_a_r_d _I_/_O _S_t_r_e_a_m_s, _f_o_p_e_n(), _f_t_e_l_l(), _r_e_w_i_n_d(), _u_n_g_e_t_c()

       The Base Definitions volume of POSIX.1-2017, <<ssttddiioo..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  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.opengroup.org/unix/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                  2017                           FGETPOS(3)
