User

Detailed Description

Exports for User.

---

Using this library in your project

Include the header file in your project:

#include <psp2/apputil.h> 

Link the library to the executable:

SceAppUtil_stub 

Load the required module:

sceSysmoduleLoadModule(SCE_SYSMODULE_APPUTIL); 

---

Functions
	VITASDK_BUILD_ASSERT_EQ (0x2C, SceAppUtilBgdlStatus)
	VITASDK_BUILD_ASSERT_EQ (0x40, SceAppUtilInitParam)
	VITASDK_BUILD_ASSERT_EQ (0x28, SceAppUtilBootParam)
	VITASDK_BUILD_ASSERT_EQ (0x10, SceAppUtilSaveDataMountPoint)
	VITASDK_BUILD_ASSERT_EQ (0x404, SceAppUtilAppEventParam)
	VITASDK_BUILD_ASSERT_EQ (0x10, SceAppUtilMountPoint)
	VITASDK_BUILD_ASSERT_EQ (0x30, SceAppUtilSaveDataSlotEmptyParam)
	VITASDK_BUILD_ASSERT_EQ (0x10, SceAppUtilSaveDataSlot)
	VITASDK_BUILD_ASSERT_EQ (0x34C, SceAppUtilSaveDataSlotParam)
	VITASDK_BUILD_ASSERT_EQ (0x40, SceAppUtilSaveDataSaveItem)
	VITASDK_BUILD_ASSERT_EQ (0x40, SceAppUtilSaveDataFile)
	VITASDK_BUILD_ASSERT_EQ (0x28, SceAppUtilSaveDataFileSlot)
	VITASDK_BUILD_ASSERT_EQ (0x2C, SceAppUtilSaveDataRemoveItem)
	VITASDK_BUILD_ASSERT_EQ (8, SceAppUtilStoreBrowseParam)
	VITASDK_BUILD_ASSERT_EQ (0x10, SceAppUtilWebBrowserParam)
int	sceAppUtilInit (SceAppUtilInitParam *initParam, SceAppUtilBootParam *bootParam)
	Initializes the AppUtil library. More...
int	sceAppUtilShutdown ()
	Shutdown AppUtil library. More...
int	sceAppUtilReceiveAppEvent (SceAppUtilAppEventParam *eventParam)
	Receive app event. More...
int	sceAppUtilAppEventParseLiveArea (const SceAppUtilAppEventParam *eventParam, char *buffer)
	Parse received app event from LiveArea. More...
int	sceAppUtilSaveDataSlotCreate (unsigned int slotId, SceAppUtilSaveDataSlotParam *param, SceAppUtilSaveDataMountPoint *mountPoint)
	Create savedata slot. More...
int	sceAppUtilSaveDataSlotDelete (unsigned int slotId, SceAppUtilSaveDataMountPoint *mountPoint)
	Delete savedata slot. More...
int	sceAppUtilSaveDataSlotSetParam (unsigned int slotId, SceAppUtilSaveDataSlotParam *param, SceAppUtilSaveDataMountPoint *mountPoint)
	Set savedata slot param. More...
int	sceAppUtilSaveDataSlotGetParam (unsigned int slotId, SceAppUtilSaveDataSlotParam *param, SceAppUtilSaveDataMountPoint *mountPoint)
	Get savedata slot param. More...
int	sceAppUtilSaveDataDataSave (SceAppUtilSaveDataFileSlot *slot, SceAppUtilSaveDataFile *files, unsigned int fileNum, SceAppUtilSaveDataMountPoint *mountPoint, SceSize *requiredSizeKB)
	Delete savedata files. More...
int	sceAppUtilSaveDataDataRemove (SceAppUtilSaveDataFileSlot *slot, SceAppUtilSaveDataRemoveItem *files, unsigned int fileNum, SceAppUtilSaveDataMountPoint *mountPoint)
int	sceAppUtilMusicMount ()
	Mount music data. More...
int	sceAppUtilMusicUmount ()
	Unmount music data. More...
int	sceAppUtilPhotoMount ()
	Mount photo data. More...
int	sceAppUtilPhotoUmount ()
	Unmount photo data. More...
int	sceAppUtilCacheMount ()
	Mount cache data. More...
int	sceAppUtilCacheUmount ()
	Unmount cache data. More...
int	sceAppUtilSystemParamGetInt (unsigned int paramId, int *value)
	Get system parameters for int type. More...
int	sceAppUtilSystemParamGetString (unsigned int paramId, SceChar8 *buf, SceSize bufSize)
	Get application parameters for string type. More...
int	sceAppUtilAppParamGetInt (SceAppUtilAppParamId paramId, int *value)
	Get application parameters for int type. More...
int	sceAppUtilSaveSafeMemory (void *buf, SceSize bufSize, SceOff offset)
	Save safe memory. More...
int	sceAppUtilLoadSafeMemory (void *buf, SceSize bufSize, SceOff offset)
	Load safe memory. More...
int	sceAppUtilStoreBrowse (SceAppUtilStoreBrowseParam *param)
	Launch PSN Store. More...
int	sceAppUtilBgdlGetStatus (SceAppUtilBgdlStatus *stat)
	Get background download status. More...
int	sceAppUtilLaunchWebBrowser (SceAppUtilWebBrowserParam *param)
	Launch web browser app. More...

Typedefs
typedef unsigned int	SceAppUtilBootAttribute
typedef unsigned int	SceAppUtilAppEventType
typedef unsigned int	SceAppUtilSaveDataSlotId
typedef unsigned int	SceAppUtilSaveDataSlotStatus
typedef unsigned int	SceAppUtilAppParamId
typedef unsigned int	SceAppUtilBgdlStatusType

---

Data Structure Documentation

SceAppUtilBgdlStatus

struct SceAppUtilBgdlStatus

Data Fields
SceAppUtilBgdlStatusType	type
SceUInt32	addcontNumReady
SceUInt32	addcontNumNotReady
SceUInt32	licenseReady
SceChar8	reserved[28]

SceAppUtilInitParam

struct SceAppUtilInitParam

Data Fields
SceSize	workBufSize	Buffer size.
uint8_t	reserved[60]	Reserved range.

SceAppUtilBootParam

struct SceAppUtilBootParam

Data Fields
SceAppUtilBootAttribute	attr	Boot attribute.
unsigned int	appVersion	App version.
uint8_t	reserved[32]	Reserved range.

SceAppUtilSaveDataMountPoint

struct SceAppUtilSaveDataMountPoint

Data Fields
uint8_t	data[16]

SceAppUtilAppEventParam

struct SceAppUtilAppEventParam

Data Fields
SceAppUtilAppEventType	type	Event type.
uint8_t	dat[1024]	Event parameter.

SceAppUtilMountPoint

struct SceAppUtilMountPoint

Data Fields
int8_t	data[16]	Mount point.

SceAppUtilSaveDataSlotEmptyParam

struct SceAppUtilSaveDataSlotEmptyParam

Data Fields
SceWChar16 *	title	Title string.
char *	iconPath	Path to icon.
void *	iconBuf	Icon buffer.
SceSize	iconBufSize	Icon buffer size.
uint8_t	reserved[32]	Reserved range.

SceAppUtilSaveDataSlot

struct SceAppUtilSaveDataSlot

Data Fields
SceAppUtilSaveDataSlotId	id	Slot id.
SceAppUtilSaveDataSlotStatus	status	Slot status.
int	userParam	Param for free usage.
SceAppUtilSaveDataSlotEmptyParam *	emptyParam	Settings for empty slot.

SceAppUtilSaveDataSlotParam

struct SceAppUtilSaveDataSlotParam

Data Fields
SceAppUtilSaveDataSlotStatus	status	Status.
SceWChar16	title[32]	Title name.
SceWChar16	subTitle[64]	Subtitle.
SceWChar16	detail[256]	Detail info.
char	iconPath[64]	Icon path.
int	userParam	User param.
SceSize	sizeKB	Data size (In KB)
SceDateTime	modifiedTime	Last modified time.
uint8_t	reserved[48]	Reserved range.

SceAppUtilSaveDataSaveItem

struct SceAppUtilSaveDataSaveItem

Data Fields
const char *	dataPath	Path to savedata.
const void *	buf	Buffer of savedata file.
uint32_t	pad	Padding.
SceOff	offset	Offset of savedata file.
int	mode	Savedata save mode (One of ::SceAppUtilSaveDataSaveMode)
uint8_t	reserved[36]	Reserved range.

SceAppUtilSaveDataFile

struct SceAppUtilSaveDataFile

Data Fields
const char *	filePath
void *	buf
SceSize	bufSize
SceOff	offset
unsigned int	mode
unsigned int	progDelta
uint8_t	reserved[32]

SceAppUtilSaveDataFileSlot

struct SceAppUtilSaveDataFileSlot

Data Fields
unsigned int	id
SceAppUtilSaveDataSlotParam *	slotParam
uint8_t	reserved[32]

SceAppUtilSaveDataRemoveItem

struct SceAppUtilSaveDataRemoveItem

Data Fields
const char *	dataPath	Path to savedata data.
int	mode	Savedata remove mode (One of ::SceAppUtilSaveDataRemoveMode)
uint8_t	reserved[36]	Reserved range.

SceAppUtilStoreBrowseParam

struct SceAppUtilStoreBrowseParam

Data Fields
unsigned int	type	Store browse type.
const char *	id	Target id.

SceAppUtilWebBrowserParam

struct SceAppUtilWebBrowserParam

Data Fields
const char *	str	String that's passed to command specified by launchMode.
SceSize	strlen	Length of str.
unsigned int	launchMode	Browser mode.
unsigned int	reserved	Reserved area.

Typedef Documentation

SceAppUtilBootAttribute

typedef unsigned int SceAppUtilBootAttribute

SceAppUtilAppEventType

typedef unsigned int SceAppUtilAppEventType

SceAppUtilSaveDataSlotId

typedef unsigned int SceAppUtilSaveDataSlotId

SceAppUtilSaveDataSlotStatus

typedef unsigned int SceAppUtilSaveDataSlotStatus

SceAppUtilAppParamId

typedef unsigned int SceAppUtilAppParamId

SceAppUtilBgdlStatusType

typedef unsigned int SceAppUtilBgdlStatusType

Enumeration Type Documentation

SceAppUtilSaveDataDataRemoveMode

enum SceAppUtilSaveDataDataRemoveMode

Enumerator
SCE_APPUTIL_SAVEDATA_DATA_REMOVE_MODE_DEFAULT
SCE_APPUTIL_SAVEDATA_DATA_REMOVE_MODE_NO_SLOT

SceAppUtilSaveDataDataSaveMode

enum SceAppUtilSaveDataDataSaveMode

Enumerator
SCE_APPUTIL_SAVEDATA_DATA_SAVE_MODE_FILE
SCE_APPUTIL_SAVEDATA_DATA_SAVE_MODE_DIRECTORY

SceAppUtilErrorCode

enum SceAppUtilErrorCode

Enumerator
SCE_APPUTIL_ERROR_PARAMETER
SCE_APPUTIL_ERROR_NOT_INITIALIZED
SCE_APPUTIL_ERROR_NO_MEMORY
SCE_APPUTIL_ERROR_BUSY
SCE_APPUTIL_ERROR_NOT_MOUNTED
SCE_APPUTIL_ERROR_NO_PERMISSION
SCE_APPUTIL_ERROR_PASSCODE_MISMATCH
SCE_APPUTIL_ERROR_APPEVENT_PARSE_INVALID_DATA
SCE_APPUTIL_ERROR_SAVEDATA_SLOT_EXISTS
SCE_APPUTIL_ERROR_SAVEDATA_SLOT_NOT_FOUND
SCE_APPUTIL_ERROR_SAVEDATA_NO_SPACE_QUOTA
SCE_APPUTIL_ERROR_SAVEDATA_NO_SPACE_FS
SCE_APPUTIL_ERROR_DRM_NO_ENTITLEMENT
SCE_APPUTIL_ERROR_PHOTO_DEVICE_NOT_FOUND
SCE_APPUTIL_ERROR_MUSIC_DEVICE_NOT_FOUND
SCE_APPUTIL_ERROR_MOUNT_LIMIT_OVER
SCE_APPUTIL_ERROR_STACKSIZE_TOO_SHORT

Function Documentation

VITASDK_BUILD_ASSERT_EQ() [1/15]

VITASDK_BUILD_ASSERT_EQ	(	0x2C	,
		SceAppUtilBgdlStatus
	)

VITASDK_BUILD_ASSERT_EQ() [2/15]

VITASDK_BUILD_ASSERT_EQ	(	0x40	,
		SceAppUtilInitParam
	)

VITASDK_BUILD_ASSERT_EQ() [3/15]

VITASDK_BUILD_ASSERT_EQ	(	0x28	,
		SceAppUtilBootParam
	)

VITASDK_BUILD_ASSERT_EQ() [4/15]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAppUtilSaveDataMountPoint
	)

VITASDK_BUILD_ASSERT_EQ() [5/15]

VITASDK_BUILD_ASSERT_EQ	(	0x404	,
		SceAppUtilAppEventParam
	)

VITASDK_BUILD_ASSERT_EQ() [6/15]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAppUtilMountPoint
	)

VITASDK_BUILD_ASSERT_EQ() [7/15]

VITASDK_BUILD_ASSERT_EQ	(	0x30	,
		SceAppUtilSaveDataSlotEmptyParam
	)

VITASDK_BUILD_ASSERT_EQ() [8/15]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAppUtilSaveDataSlot
	)

VITASDK_BUILD_ASSERT_EQ() [9/15]

VITASDK_BUILD_ASSERT_EQ	(	0x34C	,
		SceAppUtilSaveDataSlotParam
	)

VITASDK_BUILD_ASSERT_EQ() [10/15]

VITASDK_BUILD_ASSERT_EQ	(	0x40	,
		SceAppUtilSaveDataSaveItem
	)

VITASDK_BUILD_ASSERT_EQ() [11/15]

VITASDK_BUILD_ASSERT_EQ	(	0x40	,
		SceAppUtilSaveDataFile
	)

VITASDK_BUILD_ASSERT_EQ() [12/15]

VITASDK_BUILD_ASSERT_EQ	(	0x28	,
		SceAppUtilSaveDataFileSlot
	)

VITASDK_BUILD_ASSERT_EQ() [13/15]

VITASDK_BUILD_ASSERT_EQ	(	0x2C	,
		SceAppUtilSaveDataRemoveItem
	)

VITASDK_BUILD_ASSERT_EQ() [14/15]

VITASDK_BUILD_ASSERT_EQ	(	8	,
		SceAppUtilStoreBrowseParam
	)

VITASDK_BUILD_ASSERT_EQ() [15/15]

VITASDK_BUILD_ASSERT_EQ	(	0x10	,
		SceAppUtilWebBrowserParam
	)

sceAppUtilInit()

int sceAppUtilInit	(	SceAppUtilInitParam *	initParam,
		SceAppUtilBootParam *	bootParam
	)

Initializes the AppUtil library.

Call this before any of the other functions.

Parameters

[out]	initParam	- App init info. Must be initialized with zeros.
[out]	bootParam	- App boot info. Must be initialized with zeros.

Returns

0 on success, < 0 on error.

sceAppUtilShutdown()

int sceAppUtilShutdown

(

)

Shutdown AppUtil library.

sceAppUtilReceiveAppEvent()

int sceAppUtilReceiveAppEvent

(

SceAppUtilAppEventParam *

eventParam

)

Receive app event.

sceAppUtilAppEventParseLiveArea()

int sceAppUtilAppEventParseLiveArea	(	const SceAppUtilAppEventParam *	eventParam,
		char *	buffer
	)

Parse received app event from LiveArea.

sceAppUtilSaveDataSlotCreate()

int sceAppUtilSaveDataSlotCreate	(	unsigned int	slotId,
		SceAppUtilSaveDataSlotParam *	param,
		SceAppUtilSaveDataMountPoint *	mountPoint
	)

Create savedata slot.

sceAppUtilSaveDataSlotDelete()

int sceAppUtilSaveDataSlotDelete	(	unsigned int	slotId,
		SceAppUtilSaveDataMountPoint *	mountPoint
	)

Delete savedata slot.

sceAppUtilSaveDataSlotSetParam()

int sceAppUtilSaveDataSlotSetParam	(	unsigned int	slotId,
		SceAppUtilSaveDataSlotParam *	param,
		SceAppUtilSaveDataMountPoint *	mountPoint
	)

Set savedata slot param.

sceAppUtilSaveDataSlotGetParam()

int sceAppUtilSaveDataSlotGetParam	(	unsigned int	slotId,
		SceAppUtilSaveDataSlotParam *	param,
		SceAppUtilSaveDataMountPoint *	mountPoint
	)

Get savedata slot param.

Write savedata files and directories

sceAppUtilSaveDataDataSave()

int sceAppUtilSaveDataDataSave	(	SceAppUtilSaveDataFileSlot *	slot,
		SceAppUtilSaveDataFile *	files,
		unsigned int	fileNum,
		SceAppUtilSaveDataMountPoint *	mountPoint,
		SceSize *	requiredSizeKB
	)

Delete savedata files.

sceAppUtilSaveDataDataRemove()

int sceAppUtilSaveDataDataRemove	(	SceAppUtilSaveDataFileSlot *	slot,
		SceAppUtilSaveDataRemoveItem *	files,
		unsigned int	fileNum,
		SceAppUtilSaveDataMountPoint *	mountPoint
	)

sceAppUtilMusicMount()

int sceAppUtilMusicMount

(

)

Mount music data.

sceAppUtilMusicUmount()

int sceAppUtilMusicUmount

(

)

Unmount music data.

sceAppUtilPhotoMount()

int sceAppUtilPhotoMount

(

)

Mount photo data.

sceAppUtilPhotoUmount()

int sceAppUtilPhotoUmount

(

)

Unmount photo data.

sceAppUtilCacheMount()

int sceAppUtilCacheMount

(

)

Mount cache data.

sceAppUtilCacheUmount()

int sceAppUtilCacheUmount

(

)

Unmount cache data.

sceAppUtilSystemParamGetInt()

int sceAppUtilSystemParamGetInt	(	unsigned int	paramId,
		int *	value
	)

Get system parameters for int type.

sceAppUtilSystemParamGetString()

int sceAppUtilSystemParamGetString	(	unsigned int	paramId,
		SceChar8 *	buf,
		SceSize	bufSize
	)

Get application parameters for string type.

sceAppUtilAppParamGetInt()

int sceAppUtilAppParamGetInt	(	SceAppUtilAppParamId	paramId,
		int *	value
	)

Get application parameters for int type.

sceAppUtilSaveSafeMemory()

int sceAppUtilSaveSafeMemory	(	void *	buf,
		SceSize	bufSize,
		SceOff	offset
	)

Save safe memory.

sceAppUtilLoadSafeMemory()

int sceAppUtilLoadSafeMemory	(	void *	buf,
		SceSize	bufSize,
		SceOff	offset
	)

Load safe memory.

sceAppUtilStoreBrowse()

int sceAppUtilStoreBrowse

(

SceAppUtilStoreBrowseParam *

param

)

Launch PSN Store.

sceAppUtilBgdlGetStatus()

int sceAppUtilBgdlGetStatus

(

SceAppUtilBgdlStatus *

stat

)

Get background download status.

sceAppUtilLaunchWebBrowser()

int sceAppUtilLaunchWebBrowser

(

SceAppUtilWebBrowserParam *

param

)

Launch web browser app.