File: gfs_pio_gets.3.html

package info (click to toggle)
gfarm 2.7.20%2Bdfsg-1
links: PTS, VCS
area: main
in suites: bookworm
size: 24,880 kB
sloc: ansic: 188,235; sh: 43,469; cpp: 9,442; java: 6,866; makefile: 3,519; perl: 2,412; python: 1,449; ruby: 965; php: 807; sql: 173; xml: 51; csh: 2
file content (297 lines) | stat: -rw-r--r-- 4,354 bytes
parent folder | download | duplicates (8)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML
><HEAD
><TITLE
>gfs_pio_gets</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="GFS-PIO-GETS.3"
></A
>gfs_pio_gets</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="NAME"
></A
><H2
>Name</H2
>gfs_pio_gets&nbsp;--&nbsp;read one line</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="SYNOPSIS"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN12"
></A
><P
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;gfarm/gfarm.h&#62;</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
><TT
CLASS="FUNCTION"
><SPAN
CLASS="RETURNVALUE"
>char *</SPAN
>gfs_pio_gets</TT
></CODE
>(GFS_File <TT
CLASS="PARAMETER"
><I
>f</I
></TT
>, char * <TT
CLASS="PARAMETER"
><I
>s</I
></TT
>, size_t <TT
CLASS="PARAMETER"
><I
>size</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="DESCRIPTION"
></A
><H2
>DESCRIPTION</H2
><P
><TT
CLASS="FUNCTION"
>gfs_pio_gets()</TT
> reads one line from
the file specified by the parameter
<TT
CLASS="PARAMETER"
><I
>gf</I
></TT
>
to the buffer specified by the parameter
<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>.
You need to specify the size of the buffer by the parameter
<TT
CLASS="PARAMETER"
><I
>size</I
></TT
>.</P
><P
>Unlike gfs_pio_getline(3), this function doesn't remove newline
character at the end of the buffer. But if whole contents of the 
line cannot be stored to the buffer due to its length, or if the
file reaches the end without newline, there will be no newline
at the end of the buffer. In any case, one '\0' character is
appended to the end of the buffer.</P
><P
>If the file reaches its end, the length of the string in the buffer
becomes 0.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="RETURN-VALUES"
></A
><H2
>RETURN VALUES</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="CONSTANT"
>NULL</TT
></DT
><DD
><P
>The function terminated successfully.</P
></DD
><DT
><TT
CLASS="CONSTANT"
>GFARM_ERR_NO_MEMORY</TT
></DT
><DD
><P
>Insufficient memory was available.</P
></DD
><DT
>Others</DT
><DD
><P
>An error except the above occurred.  The reason is shown by its
pointed strings.</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="EXAMPLES"
></A
><H2
>EXAMPLES</H2
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN52"
></A
><P
><B
>Example 1. Example of <TT
CLASS="FUNCTION"
>gfs_pio_gets</TT
> function</B
></P
><P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>#include &#60;stdio.h&#62;
#include &#60;stdlib.h&#62;
#include &#60;gfarm/gfarm.h&#62;

int
main(int argc, char **argv)
{
	char *e;
	GFS_File gf;
	char buffer[512];

	e = gfarm_initialize(&#38;argc, &#38;argv);
	if (e != NULL) {
		fprintf(stderr, "gfarm_initialize: %s\n", e);
		return (EXIT_FAILURE);
	}
	if (argc &#60;= 1) {
		fprintf(stderr, "missing gfarm filename\n");
		return (EXIT_FAILURE);
	}
	e = gfs_pio_open(argv[1], GFARM_FILE_RDONLY, &#38;gf);
	if (e != NULL) {
		fprintf(stderr, "%s: %s\n", argv[1], e);
		return (EXIT_FAILURE);
	}
	e = gfs_pio_set_view_global(gf, 0);
	if (e != NULL) {
		fprintf(stderr, "%s: gfs_pio_set_view_global: %s\n",
		    argv[1], e);
		return (EXIT_FAILURE);
	}

	while ((e = gfs_pio_gets(gf, buffer, sizeof buffer)) != NULL &#38;&#38;
	    *buffer != '\0') {
		printf("got: %s", buffer);
	}
	if (e != NULL) {
		fprintf(stderr, "ERROR: %s\n", e);
		return (EXIT_FAILURE);
	}
	e = gfs_pio_close(gf);
	if (e != NULL) {
		fprintf(stderr, "gfs_pio_close: %s\n", e);
		return (EXIT_FAILURE);
	}
	e = gfarm_terminate();
	if (e != NULL) {
		fprintf(stderr, "gfarm_initialize: %s\n", e);
		return (EXIT_FAILURE);
	}
	return (EXIT_SUCCESS);
}</PRE
></TD
></TR
></TABLE
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="SEE-ALSO"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>gfs_pio_open</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>gfs_pio_getline</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>gfs_pio_readline</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>gfs_pio_readdelim</SPAN
>(3)</SPAN
></P
></DIV
></BODY
></HTML
>