User

Exports for User. More...

Data Structures
struct	SceIoDevctlOpt
struct	sceIoChstatOpt
struct	sceIoDopenOpt
struct	sceIoGetstatOpt
struct	sceIoMkdirOpt
struct	sceIoOpenOpt
struct	sceIoRemoveOpt
struct	sceIoRenameOpt
struct	sceIoRmdirOpt
struct	sceIoSyncOpt

Functions
SceUID	sceIoOpen (const char *file, int flags, SceMode mode)
	Open or create a file for reading or writing.
int	sceIoClose (SceUID fd)
	Delete a descriptor.
SceSSize	sceIoRead (SceUID fd, void *buf, SceSize nbyte)
	Read input.
int	sceIoPread (SceUID fd, void *data, SceSize size, SceOff offset)
	Read input at offset.
SceSSize	sceIoWrite (SceUID fd, const void *buf, SceSize nbyte)
	Write output.
int	sceIoPwrite (SceUID fd, const void *data, SceSize size, SceOff offset)
	Write output at offset.
SceOff	sceIoLseek (SceUID fd, SceOff offset, int whence)
	Reposition read/write file descriptor offset.
long	sceIoLseek32 (SceUID fd, long offset, int whence)
	Reposition read/write file descriptor offset (32bit mode)
int	sceIoRemove (const char *file)
	Remove directory entry.
int	sceIoRename (const char *oldname, const char *newname)
	Change the name of a file.
int	sceIoSync (const char *device, unsigned int flags)
	Synchronize the file data on the device.
int	sceIoSyncByFd (SceUID fd, int flag)
	Synchronize the file data for one file.
int	sceIoCancel (SceUID fd)
	Cancel an asynchronous operation on a file descriptor.
int	sceIoGetPriority (SceUID fd)
int	sceIoGetProcessDefaultPriority (void)
int	sceIoGetThreadDefaultPriority (void)
int	sceIoSetPriority (SceUID fd, int priority)
int	sceIoSetProcessDefaultPriority (int priority)
int	sceIoSetThreadDefaultPriority (int priority)
	VITASDK_BUILD_ASSERT_EQ (0x18, SceIoDevctlOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoChstatOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoDopenOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoGetstatOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoMkdirOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoOpenOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoRemoveOpt)
	VITASDK_BUILD_ASSERT_EQ (0x10, sceIoRenameOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoRmdirOpt)
	VITASDK_BUILD_ASSERT_EQ (0x8, sceIoSyncOpt)
int	_sceIoChstat (const char *name, const SceIoStat *stat, unsigned int cbit, const sceIoChstatOpt *opt)
	User export used by sceIoChstat.
int	_sceIoChstatByFd (SceUID fd, const SceIoStat *buf, unsigned int cbit)
	User export used by sceIoChstatByFd.
int	_sceIoDevctl (const char *devname, int cmd, const void *arg, const SceIoDevctlOpt *opt)
	User export used by sceIoDevctl.
SceUID	_sceIoDopen (const char *dirname, const sceIoDopenOpt *opt)
	User export used by sceIoDopen.
int	_sceIoDread (SceUID fd, SceIoDirent *dir)
	User export used by sceIoDread.
int	_sceIoGetstat (const char *name, SceIoStat *buf, const sceIoGetstatOpt *opt)
	User export used by sceIoGetstat.
int	_sceIoGetstatByFd (SceUID fd, SceIoStat *stat)
	User export used by sceIoGetstatByFd.
int	_sceIoMkdir (const char *dirname, SceMode mode, const sceIoMkdirOpt *opt)
	User export used by sceIoMkdir.
SceUID	_sceIoOpen (const char *filename, int flags, SceMode mode, const sceIoOpenOpt *opt)
	User export used by sceIoOpen.
int	_sceIoRemove (const char *filename, const sceIoRemoveOpt *opt)
	User export used by sceIoRemove.
int	_sceIoRename (const char *oldname, const char *newname, const sceIoRenameOpt *opt)
	User export used by sceIoRename.
int	_sceIoRmdir (const char *dirname, const sceIoRmdirOpt *opt)
	User export used by sceIoRmdir.
int	_sceIoSync (const char *device, unsigned int flags, const sceIoSyncOpt *opt)
	User export used by sceIoSync.

Variables
SceSize	SceIoDevctlOpt::arglen
	Size of the device-driver-specific parameter block in bytes.
void *	SceIoDevctlOpt::bufp
	Output buffer.
SceSize	SceIoDevctlOpt::buflen
	Output buffer size.
SceUInt32	SceIoDevctlOpt::reserved [3]
	Ignored on FW 3.60.
SceUInt32	sceIoChstatOpt::reserved [2]
	Ignored on FW 3.60.
SceUInt32	sceIoDopenOpt::reserved [2]
	Ignored on FW 3.60.
SceUInt32	sceIoGetstatOpt::reserved [2]
	Ignored on FW 3.60.
SceUInt32	sceIoMkdirOpt::reserved [2]
	Ignored on FW 3.60.
SceUInt32	sceIoOpenOpt::reserved [2]
	Ignored on FW 3.60.
SceUInt32	sceIoRemoveOpt::reserved [2]
	Ignored on FW 3.60.
SceUInt32	sceIoRenameOpt::reserved [4]
	Ignored on FW 3.60.
SceUInt32	sceIoRmdirOpt::reserved [2]
	Ignored on FW 3.60.
SceUInt32	sceIoSyncOpt::reserved [2]
	Ignored on FW 3.60.

Detailed Description

Exports for User.

---

Using this library in your project

Include the header file in your project:

#include <psp2/io/fcntl.h> 

Link the library to the executable:

SceIofilemgr_stub 

---

---

Data Structure Documentation

SceIoDevctlOpt

struct SceIoDevctlOpt

Data Fields
SceSize	arglen	Size of the device-driver-specific parameter block in bytes.
void *	bufp	Output buffer.
SceSize	buflen	Output buffer size.
SceUInt32	reserved[3]	Ignored on FW 3.60.

sceIoChstatOpt

struct sceIoChstatOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

sceIoDopenOpt

struct sceIoDopenOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

sceIoGetstatOpt

struct sceIoGetstatOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

sceIoMkdirOpt

struct sceIoMkdirOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

sceIoOpenOpt

struct sceIoOpenOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

sceIoRemoveOpt

struct sceIoRemoveOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

sceIoRenameOpt

struct sceIoRenameOpt

Data Fields
SceUInt32	reserved[4]	Ignored on FW 3.60.

sceIoRmdirOpt

struct sceIoRmdirOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

sceIoSyncOpt

struct sceIoSyncOpt

Data Fields
SceUInt32	reserved[2]	Ignored on FW 3.60.

Function Documentation

sceIoOpen()

SceUID sceIoOpen	(	const char *	file,
		int	flags,
		SceMode	mode
	)

Open or create a file for reading or writing.

Example1: Open a file for reading

if((fd = sceIoOpen("device:/path/to/file", SCE_O_RDONLY, 0777) < 0) {
// error code in fd, for example no open filehandle left (0x80010018)
}

Example2: Open a file for writing, creating it if it doesn't exist

if((fd = sceIoOpen("device:/path/to/file", SCE_O_WRONLY|SCE_O_CREAT, 0777) < 0) {
// error code in fd, for example no open filehandle left (0x80010018)
}

Parameters

file	- Pointer to a string holding the name of the file to open.
flags	- Libc styled flags that are or'ed together (One or more SceIoMode).
mode	- One or more SceIoAccessMode flags or'ed together. Can also use Unix absolute permissions.

Returns

> 0 is a valid file handle, < 0 on error.

sceIoClose()

int sceIoClose

(

SceUID

fd

)

Delete a descriptor.

sceIoClose(fd);

Parameters

fd	- File descriptor to close

Returns

< 0 on error

sceIoRead()

SceSSize sceIoRead	(	SceUID	fd,
		void *	buf,
		SceSize	nbyte
	)

Read input.

Example:

bytes_read = sceIoRead(fd, data, 100);

Parameters

fd	- Opened file descriptor to read from
buf	- Pointer to the buffer where the read data will be placed
nbyte	- Size of the read in bytes

Returns

The number of bytes read

sceIoPread()

int sceIoPread	(	SceUID	fd,
		void *	data,
		SceSize	size,
		SceOff	offset
	)

Read input at offset.

Example:

bytes_read = sceIoPread(fd, data, 100, 0x1000);

Parameters

fd	- Opened file descriptor to read from
data	- Pointer to the buffer where the read data will be placed
size	- Size of the read in bytes
offset	- Offset to read

Returns

< 0 on error.

sceIoWrite()

SceSSize sceIoWrite	(	SceUID	fd,
		const void *	buf,
		SceSize	nbyte
	)

Write output.

Example:

bytes_written = sceIoWrite(fd, data, 100);

Parameters

fd	- Opened file descriptor to write to
buf	- Pointer to the data to write
nbyte	- Size of data to write

Returns

The number of bytes written

sceIoPwrite()

int sceIoPwrite	(	SceUID	fd,
		const void *	data,
		SceSize	size,
		SceOff	offset
	)

Write output at offset.

Example:

bytes_written = sceIoPwrite(fd, data, 100, 0x1000);

Parameters

fd	- Opened file descriptor to write to
data	- Pointer to the data to write
size	- Size of data to write
offset	- Offset to write

Returns

The number of bytes written

sceIoLseek()

SceOff sceIoLseek	(	SceUID	fd,
		SceOff	offset,
		int	whence
	)

Reposition read/write file descriptor offset.

Example:

pos = sceIoLseek(fd, -10, SCE_SEEK_END);

Parameters

fd	- Opened file descriptor with which to seek
offset	- Relative offset from the start position given by whence
whence	- One of SceIoSeekMode.

Returns

The position in the file after the seek.

sceIoLseek32()

long sceIoLseek32	(	SceUID	fd,
		long	offset,
		int	whence
	)

Reposition read/write file descriptor offset (32bit mode)

Example:

pos = sceIoLseek32(fd, -10, SCE_SEEK_END);

Parameters

fd	- Opened file descriptor with which to seek
offset	- Relative offset from the start position given by whence
whence	- One of SceIoSeekMode.

Returns

The position in the file after the seek.

sceIoRemove()

int sceIoRemove

(

const char *

file

)

Remove directory entry.

Parameters

file	- Path to the file to remove

Returns

< 0 on error

sceIoRename()

int sceIoRename	(	const char *	oldname,
		const char *	newname
	)

Change the name of a file.

Parameters

oldname	- The old filename
newname	- The new filename

Returns

< 0 on error.

sceIoSync()

int sceIoSync	(	const char *	device,
		unsigned int	flags
	)

Synchronize the file data on the device.

Parameters

device	- The device to synchronize (e.g. msfat0:)
flags	- Mount synchronization flags. FW 3.60 forwards this value when synchronizing the buffer cache for the entire mount.

sceIoSyncByFd()

int sceIoSyncByFd	(	SceUID	fd,
		int	flag
	)

Synchronize the file data for one file.

Parameters

fd	- Opened file descriptor to sync
flag	- unknown

Returns

< 0 on error.

sceIoCancel()

int sceIoCancel

(

SceUID

fd

)

Cancel an asynchronous operation on a file descriptor.

Parameters

fd	- The file descriptor to perform cancel on.

Returns

< 0 on error.

sceIoGetPriority()

int sceIoGetPriority

(

SceUID

fd

)

sceIoGetProcessDefaultPriority()

int sceIoGetProcessDefaultPriority

(

void

)

sceIoGetThreadDefaultPriority()

int sceIoGetThreadDefaultPriority

(

void

)

sceIoSetPriority()

int sceIoSetPriority	(	SceUID	fd,
		int	priority
	)

sceIoSetProcessDefaultPriority()

int sceIoSetProcessDefaultPriority

(

int

priority

)

sceIoSetThreadDefaultPriority()

int sceIoSetThreadDefaultPriority

(

int

priority

)

VITASDK_BUILD_ASSERT_EQ() [1/10]

VITASDK_BUILD_ASSERT_EQ	(	0x18	,
		SceIoDevctlOpt
	)

VITASDK_BUILD_ASSERT_EQ() [2/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoChstatOpt
	)

VITASDK_BUILD_ASSERT_EQ() [3/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoDopenOpt
	)

VITASDK_BUILD_ASSERT_EQ() [4/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoGetstatOpt
	)

VITASDK_BUILD_ASSERT_EQ() [5/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoMkdirOpt
	)

VITASDK_BUILD_ASSERT_EQ() [6/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoOpenOpt
	)

VITASDK_BUILD_ASSERT_EQ() [7/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoRemoveOpt
	)

VITASDK_BUILD_ASSERT_EQ() [8/10]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		sceIoRenameOpt
	)

VITASDK_BUILD_ASSERT_EQ() [9/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoRmdirOpt
	)

VITASDK_BUILD_ASSERT_EQ() [10/10]

VITASDK_BUILD_ASSERT_EQ	(	0x8	,
		sceIoSyncOpt
	)

_sceIoChstat()

int _sceIoChstat	(	const char *	name,
		const SceIoStat *	stat,
		unsigned int	cbit,
		const sceIoChstatOpt *	opt
	)

User export used by sceIoChstat.

Parameters

[in]	name	- Path to modify.
[in]	stat	- Replacement values selected by cbit.
[in]	cbit	- Bitwise OR of SCE_CST_* values.
[in]	opt	- Required 8-byte option block. Its contents are ignored on FW 3.60.

Returns

0 on success, or a negative error code.

_sceIoChstatByFd()

int _sceIoChstatByFd	(	SceUID	fd,
		const SceIoStat *	buf,
		unsigned int	cbit
	)

User export used by sceIoChstatByFd.

_sceIoDevctl()

int _sceIoDevctl	(	const char *	devname,
		int	cmd,
		const void *	arg,
		const SceIoDevctlOpt *	opt
	)

User export used by sceIoDevctl.

Parameters

[in]	devname	- Device name.
[in]	cmd	- Device-specific command.
[in]	arg	- Input buffer containing opt->arglen bytes, or NULL.
[in]	opt	- Required block describing the input and output buffers.

Returns

The device-driver result, or a negative error code.

_sceIoDopen()

SceUID _sceIoDopen	(	const char *	dirname,
		const sceIoDopenOpt *	opt
	)

User export used by sceIoDopen.

The option block is required; its contents are ignored on FW 3.60.

_sceIoDread()

int _sceIoDread	(	SceUID	fd,
		SceIoDirent *	dir
	)

User export used by sceIoDread.

The structure at dir is copied to and from user memory.

_sceIoGetstat()

int _sceIoGetstat	(	const char *	name,
		SceIoStat *	buf,
		const sceIoGetstatOpt *	opt
	)

User export used by sceIoGetstat.

The option block is required; its contents are ignored on FW 3.60.

_sceIoGetstatByFd()

int _sceIoGetstatByFd	(	SceUID	fd,
		SceIoStat *	stat
	)

User export used by sceIoGetstatByFd.

_sceIoMkdir()

int _sceIoMkdir	(	const char *	dirname,
		SceMode	mode,
		const sceIoMkdirOpt *	opt
	)

User export used by sceIoMkdir.

The option block is required; its contents are ignored on FW 3.60.

_sceIoOpen()

SceUID _sceIoOpen	(	const char *	filename,
		int	flags,
		SceMode	mode,
		const sceIoOpenOpt *	opt
	)

User export used by sceIoOpen.

The option block is required; its contents are ignored on FW 3.60.

_sceIoRemove()

int _sceIoRemove	(	const char *	filename,
		const sceIoRemoveOpt *	opt
	)

User export used by sceIoRemove.

The option block is required; its contents are ignored on FW 3.60.

_sceIoRename()

int _sceIoRename	(	const char *	oldname,
		const char *	newname,
		const sceIoRenameOpt *	opt
	)

User export used by sceIoRename.

The option block is required; its contents are ignored on FW 3.60.

_sceIoRmdir()

int _sceIoRmdir	(	const char *	dirname,
		const sceIoRmdirOpt *	opt
	)

User export used by sceIoRmdir.

The option block is required; its contents are ignored on FW 3.60.

_sceIoSync()

int _sceIoSync	(	const char *	device,
		unsigned int	flags,
		const sceIoSyncOpt *	opt
	)

User export used by sceIoSync.

The option block is required; its contents are ignored on FW 3.60.

Variable Documentation

arglen

SceSize SceIoDevctlOpt::arglen

Size of the device-driver-specific parameter block in bytes.

bufp

void* SceIoDevctlOpt::bufp

Output buffer.

buflen

SceSize SceIoDevctlOpt::buflen

Output buffer size.

reserved [1/10]

SceUInt32 SceIoDevctlOpt::reserved[3]

Ignored on FW 3.60.

reserved [2/10]

SceUInt32 sceIoChstatOpt::reserved[2]

Ignored on FW 3.60.

reserved [3/10]

SceUInt32 sceIoDopenOpt::reserved[2]

Ignored on FW 3.60.

reserved [4/10]

SceUInt32 sceIoGetstatOpt::reserved[2]

Ignored on FW 3.60.

reserved [5/10]

SceUInt32 sceIoMkdirOpt::reserved[2]

Ignored on FW 3.60.

reserved [6/10]

SceUInt32 sceIoOpenOpt::reserved[2]

Ignored on FW 3.60.

reserved [7/10]

SceUInt32 sceIoRemoveOpt::reserved[2]

Ignored on FW 3.60.

reserved [8/10]

SceUInt32 sceIoRenameOpt::reserved[4]

Ignored on FW 3.60.

reserved [9/10]

SceUInt32 sceIoRmdirOpt::reserved[2]

Ignored on FW 3.60.

reserved [10/10]

SceUInt32 sceIoSyncOpt::reserved[2]

Ignored on FW 3.60.