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





osPfsFreeBlocks

Syntax

#include <ultra64.h>
s32 osPfsFreeBlocks(OSPfs *pfs, s32 *bytes_not_used);

Explanation
It finds the available number of bytes in a Controller Pak. The available number of bytes is returned to the location pointed to by bytes_not_used.

OSPfs structure pfs is a file handle which was initialized by a function osPfsInitPak. For how to create this handle, refer to osPfsInitPak.

If this function is called successfully, a 0 is returned. 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 will be done internally. Therefore, this error is rarely seen. If this error does occur, it is possible that either the Controller is not connected properly, or the Controller Pak or Controller Socket is damaged.
  • PFS_ERR_INCONSISTENT - There is a problem in the file system's management area. Usually this error does not occur, because osPfsChecker is called internally when you initialize the file system by calling osPfsInitPak. If this error does occur, either the Controller Pak is not connected properly, or the Controller Pak itself is damaged.
  • PFS_ERR_INVALID - There is an error in the parameter which was specified when the function was called, or the specified game note does not exist, or Pfs function was called without initializing using osPfsInitPak. Also, this error could occur when a function for the Controller Pak is executed after the file handle structure pfs is initialized using any other function than the initialization function for this Controller Pak, osPfsInitPak. For example, when osPfsDeleteFile is executed after OSPfs structure is initialized using the initialization function for the Rumble Pak,osMotorInit. If this error is returned, check the process of the game program.
See Also
osContInit
osContStartQuery
osContGetQuery
osPfsAllocateFile
osPfsChecker
osPfsDeleteFile
osPfsFileState
osPfsFindFile
osPfsInitPak
osPfsIsPlug
osPfsReadWriteFile

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