osPfsFileState.3p
1.85 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.TH osPfsFileState 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
osPfsFileState \- Get file status
.SH SYNOPSIS
.nf
\f3
.Op c
#include <ultra64.h>
.sp .8v
s32 osPfsFileState(OSPfs \(**pfs, s32 file_no, OSPfsState \(**state);
.Op
\f1
.fi
.SH DESCRIPTION
.sp
The
.I osPfsFileState
function obtains information about a file known by the file descriptor
.I file_no,
obtained from a successful
.I osPfsAllocateFile
(3P) or
.I osPfsFindFile
(3P) function call.
.I state
is a pointer to a
.I OSPfsState
structure into which information is placed concerning the file.
The
.I OSPfs
handle
must be the handle returned from
.I osPfsInit.
See
.IR osPfsInit
(3P) for details on how to create this handle.
.sp
The contents of the structure pointed to by
.I state
include the following members:
.sp
.nf
.ta 5 15
typedef struct {
u32 file_size; /* file size in bytes */
u32 game_code;
u16 company_code;
char ext_name[4];
char game_name[16];
}
.fi
.sp
A value of 0 is returned if the calls succeed, otherwise
one of the following error code is returned.
.PP
.nf
.ta 5 26
PFS_ERR_CONTRFAIL The controller sends data at higher data
transfer rate than the hardware handling
capability or the hardware CRC error
occurs.
.sp
PFS_ERR_INVALID Invalid parameter or the specified file
does not exist. Application should change
parameter and then retry.
.sp
PFS_ERR_NEW_PACK CONTROLLER PAK has been changed to a
different one. Application needs to call
osPfsInit(3p) to initialize the new
CONTROLLER PAK.
.sp
PFS_ERR_INCONSISTENT File system is corrupted. Application needs
to call osPfsChecker(3P) to repair the file
system.
.fi
.SH "SEE ALSO"
osContInit (3P),
osPfsAllocateFile (3P),
osPfsChecker (3P),
osPfsFreeBlocks (3P),
osPfsInit (3P),
osPfsIsPlug (3P),
osPfsReSizeFile (3P),
osPfsReadWriteFile (3P),
osPfsSetLabel (3P)