osPfsSetLabel.3p
1.5 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
.TH osPfsSetLabel 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
osPfsSetLabel, osPfsGetLabel \- Label/Retrieve CONTROLLER PAK's symbolic name
.SH SYNOPSIS
.nf
\f3
.Op c
#include <ultra64.h>
.sp .8v
s32 osPfsSetLabel(OSPfs \(**pfs, u8 \(**label);
.sp .8v
s32 osPfsGetLabel(OSPfs \(**pfs, u8 \(**label, int \(**length);
.Op
\f1
.fi
.SH DESCRIPTION
.sp
The
.I osPfsSetLabel
call labels the CONTROLLER PAK with the symbolic name which is specified by
.I label.
The
.I OSPfs
handle
must be the handle returned from
.I osPfsInit.
See
.IR osPfsInit (3P)
for details on how to create this handle. The maximum characters for the
label is
.I BLOCKSIZE.
If the symbolic name is longer than
.I BLOCKSIZE,
characters past
.I BLOCKSIZE
will be ignored.
.sp
The
.I osPfsGetLabel
call retrieves the symbolic name from the CONTROLLER PAK. The user must supply
a block of memory large enough for
.I BLOCKSIZE
of characters. The length of the symbolic name is returned to
.I length.
.sp
A value of 0 is returned if the calls succeed, otherwise
one of the following error code is returned.
.PP
.nf
.ta 5 24
PFS_ERR_NOPACK No CONTROLLER PAK is plugged in the specified
controller.
.sp
PFS_ERR_CONTRFAIL The controller sends data at higher data
transfer rate than the hardware handling
capability or the hardware CRC error occurs.
.fi
.SH "SEE ALSO"
osContInit (3P),
osPfsAllocateFile (3P),
osPfsChecker (3P),
osPfsFileState (3P),
osPfsFreeBlocks (3P),
osPfsInit (3P),
osPfsIsPlug (3P),
osPfsReSizeFile (3P),
osPfsReadWriteFile (3P)