.\" This manpage has been automatically generated by docbook2man .\" from a DocBook document. This tool can be found at: .\" .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng . .TH "GFS_PIO_READ" "3" "27 June 2010" "Gfarm" "" .SH NAME gfs_pio_read \- binary stream input .SH SYNOPSIS .sp \fB#include .sp gfarm_error_t gfs_pio_read (GFS_File \fIgf\fB, void * \fIbuffer\fB, int \fIsize\fB, int * \fInp\fB); \fR .SH "DESCRIPTION" .PP \fBgfs_pio_read()\fR attempts to read up to \fIsize\fR bytes from the file referenced by \fIgf\fR into the buffer starting at \fIbuffer\fR, and returns the number of bytes read to the address pointed by \fInp\fR\&. On end of file, the number of bytes read is zero. .SH "RETURN VALUES" .TP \fBGFARM_ERR_NO_ERROR\fR The function terminated successfully. .TP \fBGFARM_ERR_OPERATION_NOT_PERMITTED\fR \fIgf\fR does not specify a regular file. .TP \fBGFARM_ERR_BAD_FILE_DESCRIPTOR\fR The file descripter specified by \fIgf\fR is not a valid or is not open for reading. .TP \fBGFARM_ERR_NO_FILE_SYSTEM_NODE\fR There is no available file system node. .TP \fBGFARM_ERR_NO_MEMORY\fR Insufficient memory was available. .TP \fBOthers\fR An error except the above occurred. The reason is shown by \fBgfarm_error_string\fR(3)\&. .SH "SEE ALSO" .PP \fBgfs_pio_create\fR(3), \fBgfs_pio_open\fR(3)