N64® Functions Menu

al - Audio Library Functions
gDP - DP GBI Macros
gdSP - General GBI Macros
gSP - SP GBI Macros
gt - Turbo Microcode RDP
gu - Graphics Utilities
Math - Math Functions
nuSys - NuSystem
os - N64 Operating System
sp - Sprite Library Functions
uh - Host to Target IO
64DD - N64 Disk Drive

Nintendo® Confidential





osPfsGetLabel

Syntax

#include <ultra64.h>
s32 osPfsGetLabel(OSPfs *pfs, u8 *label, int *length);


Explanation
This function reads the label of a Controller Pak. A BLOCKSIZE (32 bytes) label area exists in the Controller Pak. The specification for this label area has not yet been defined (as of December, 1998.) Therefore, do not use this function.

The OSPfs structure's handle must be the handle returned from osPfsInitPak. Please refer to osPfsInitPak for information on how to create this handle.

The area specified by the label needs to have the size BLOCKSIZE to store label data.

If this function is called successfully, a 0 is returned and the length of the label is returned to the location pointed to by the length argument. If an error occurs, one of the following error codes is returned:

  • PFS_ERR_NOPACK - Some type of PIF error has occurred. Either the Controller Pak is not inserted into the specified Controller or the Controller is not properly connected. To determine which is the case, use osContStartQuery or osContGetQuery.
  • PFS_ERR_NEW_PACK - A different Controller Pak has been inserted. To use the inserted Controller Pak, initialize it by calling osPfsInitPak.
  • PFS_ERR_CONTRFAIL - Data transfer to or from the Controller has failed. If a transfer error occurs, up to three tries are done internally, so this error rarely occurs. If it does occur, it is possible that either the Controller is not connected properly, or the Controller Pak or Controller Socket is damaged.
See Also
osContInit
osContStartQuery
osContGetQuery
osPfsChecker
osPfsInitPak
osPfsIsPlug
osPfsSetLabel

Revision History
2/1/1999 Revised entirely





Nintendo® Confidential

Warning: all information in this document is confidential and covered by a non-disclosure agreement. You are responsible for keeping this information confidential and protected. Nintendo will vigorously enforce this responsibility.


Copyright © 1998
Nintendo of America Inc. All rights reserved
Nintendo and N64 are registered trademarks of Nintendo
Last updated March 1998