add directory Ref-docs
This commit is contained in:
gohigh
165
Ref-docs/POSIX/susv3/functions/fgetpos.html
Normal file
165
Ref-docs/POSIX/susv3/functions/fgetpos.html
Normal file
@@ -0,0 +1,165 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
||||
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
||||
<title>fgetpos</title>
|
||||
</head>
|
||||
<body bgcolor="white">
|
||||
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
||||
</script>
|
||||
|
||||
<basefont size="3"> <a name="fgetpos"></a> <a name="tag_03_163"></a><!-- fgetpos -->
|
||||
<!--header start-->
|
||||
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
||||
IEEE Std 1003.1-2001<br>
|
||||
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
||||
|
||||
<!--header end-->
|
||||
<hr size="2" noshade>
|
||||
<h4><a name="tag_03_163_01"></a>NAME</h4>
|
||||
|
||||
<blockquote>fgetpos - get current file position information</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_02"></a>SYNOPSIS</h4>
|
||||
|
||||
<blockquote class="synopsis">
|
||||
<p><code><tt>#include <<a href="../basedefs/stdio.h.html">stdio.h</a>><br>
|
||||
<br>
|
||||
int fgetpos(FILE *restrict</tt> <i>stream</i><tt>, fpos_t *restrict</tt> <i>pos</i><tt>);<br>
|
||||
</tt></code></p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_03"></a>DESCRIPTION</h4>
|
||||
|
||||
<blockquote>
|
||||
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
|
||||
border="0"> 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 IEEE Std 1003.1-2001 defers to
|
||||
the ISO C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
|
||||
|
||||
<p>The <i>fgetpos</i>() function shall store the current values of the parse state (if any) and file position indicator for the
|
||||
stream pointed to by <i>stream</i> in the object pointed to by <i>pos</i>. The value stored contains unspecified information usable
|
||||
by <a href="../functions/fsetpos.html"><i>fsetpos</i>()</a> for repositioning the stream to its position at the time of the call to
|
||||
<i>fgetpos</i>().</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_04"></a>RETURN VALUE</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>Upon successful completion, <i>fgetpos</i>() shall return 0; otherwise, it shall return a non-zero value and set <i>errno</i> to
|
||||
indicate the error.</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_05"></a>ERRORS</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>The <i>fgetpos</i>() function shall fail if:</p>
|
||||
|
||||
<dl compact>
|
||||
<dt>[EOVERFLOW]</dt>
|
||||
|
||||
<dd><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
|
||||
The current value of the file position cannot be represented correctly in an object of type <b>fpos_t</b>. <img src=
|
||||
"../images/opt-end.gif" alt="[Option End]" border="0"></dd>
|
||||
</dl>
|
||||
|
||||
<p>The <i>fgetpos</i>() function may fail if:</p>
|
||||
|
||||
<dl compact>
|
||||
<dt>[EBADF]</dt>
|
||||
|
||||
<dd><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
|
||||
The file descriptor underlying <i>stream</i> is not valid. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></dd>
|
||||
|
||||
<dt>[ESPIPE]</dt>
|
||||
|
||||
<dd><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
|
||||
The file descriptor underlying <i>stream</i> is associated with a pipe, FIFO, or socket. <img src="../images/opt-end.gif" alt=
|
||||
"[Option End]" border="0"></dd>
|
||||
</dl>
|
||||
</blockquote>
|
||||
|
||||
<hr>
|
||||
<div class="box"><em>The following sections are informative.</em></div>
|
||||
|
||||
<h4><a name="tag_03_163_06"></a>EXAMPLES</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>None.</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_07"></a>APPLICATION USAGE</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>None.</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_08"></a>RATIONALE</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>None.</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_09"></a>FUTURE DIRECTIONS</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>None.</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_10"></a>SEE ALSO</h4>
|
||||
|
||||
<blockquote>
|
||||
<p><a href="fopen.html"><i>fopen</i>()</a> , <a href="ftell.html"><i>ftell</i>()</a> , <a href="rewind.html"><i>rewind</i>()</a> ,
|
||||
<a href="ungetc.html"><i>ungetc</i>()</a> , the Base Definitions volume of IEEE Std 1003.1-2001, <a href=
|
||||
"../basedefs/stdio.h.html"><i><stdio.h></i></a></p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_11"></a>CHANGE HISTORY</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>First released in Issue 4. Derived from the ISO C standard.</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_12"></a>Issue 5</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>Large File Summit extensions are added.</p>
|
||||
</blockquote>
|
||||
|
||||
<h4><a name="tag_03_163_13"></a>Issue 6</h4>
|
||||
|
||||
<blockquote>
|
||||
<p>Extensions beyond the ISO C standard are marked.</p>
|
||||
|
||||
<p>The following new requirements on POSIX implementations derive from alignment with the Single UNIX Specification:</p>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<p>The [EBADF] and [ESPIPE] optional error conditions are added.</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p>An additional [ESPIPE] error condition is added for sockets.</p>
|
||||
|
||||
<p>The prototype for <i>fgetpos</i>() is changed for alignment with the ISO/IEC 9899:1999 standard.</p>
|
||||
</blockquote>
|
||||
|
||||
<div class="box"><em>End of informative text.</em></div>
|
||||
|
||||
<hr>
|
||||
<hr size="2" noshade>
|
||||
<center><font size="2"><!--footer start-->
|
||||
UNIX ® is a registered Trademark of The Open Group.<br>
|
||||
POSIX ® is a registered Trademark of The IEEE.<br>
|
||||
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
||||
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
||||
]</font></center>
|
||||
|
||||
<!--footer end-->
|
||||
<hr size="2" noshade>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user