source: trunk/essentials/dev-lang/perl/pod/perlapio.pod@ 3310

Last change on this file since 3310 was 3181, checked in by bird, 19 years ago

perl 5.8.8

File size: 18.9 KB
Line 
1=head1 NAME
2
3perlapio - perl's IO abstraction interface.
4
5=head1 SYNOPSIS
6
7 #define PERLIO_NOT_STDIO 0 /* For co-existence with stdio only */
8 #include <perlio.h> /* Usually via #include <perl.h> */
9
10 PerlIO *PerlIO_stdin(void);
11 PerlIO *PerlIO_stdout(void);
12 PerlIO *PerlIO_stderr(void);
13
14 PerlIO *PerlIO_open(const char *path,const char *mode);
15 PerlIO *PerlIO_fdopen(int fd, const char *mode);
16 PerlIO *PerlIO_reopen(const char *path, const char *mode, PerlIO *old); /* deprecated */
17 int PerlIO_close(PerlIO *f);
18
19 int PerlIO_stdoutf(const char *fmt,...)
20 int PerlIO_puts(PerlIO *f,const char *string);
21 int PerlIO_putc(PerlIO *f,int ch);
22 int PerlIO_write(PerlIO *f,const void *buf,size_t numbytes);
23 int PerlIO_printf(PerlIO *f, const char *fmt,...);
24 int PerlIO_vprintf(PerlIO *f, const char *fmt, va_list args);
25 int PerlIO_flush(PerlIO *f);
26
27 int PerlIO_eof(PerlIO *f);
28 int PerlIO_error(PerlIO *f);
29 void PerlIO_clearerr(PerlIO *f);
30
31 int PerlIO_getc(PerlIO *d);
32 int PerlIO_ungetc(PerlIO *f,int ch);
33 int PerlIO_read(PerlIO *f, void *buf, size_t numbytes);
34
35 int PerlIO_fileno(PerlIO *f);
36
37 void PerlIO_setlinebuf(PerlIO *f);
38
39 Off_t PerlIO_tell(PerlIO *f);
40 int PerlIO_seek(PerlIO *f, Off_t offset, int whence);
41 void PerlIO_rewind(PerlIO *f);
42
43 int PerlIO_getpos(PerlIO *f, SV *save); /* prototype changed */
44 int PerlIO_setpos(PerlIO *f, SV *saved); /* prototype changed */
45
46 int PerlIO_fast_gets(PerlIO *f);
47 int PerlIO_has_cntptr(PerlIO *f);
48 int PerlIO_get_cnt(PerlIO *f);
49 char *PerlIO_get_ptr(PerlIO *f);
50 void PerlIO_set_ptrcnt(PerlIO *f, char *ptr, int count);
51
52 int PerlIO_canset_cnt(PerlIO *f); /* deprecated */
53 void PerlIO_set_cnt(PerlIO *f, int count); /* deprecated */
54
55 int PerlIO_has_base(PerlIO *f);
56 char *PerlIO_get_base(PerlIO *f);
57 int PerlIO_get_bufsiz(PerlIO *f);
58
59 PerlIO *PerlIO_importFILE(FILE *stdio, const char *mode);
60 FILE *PerlIO_exportFILE(PerlIO *f, int flags);
61 FILE *PerlIO_findFILE(PerlIO *f);