Save Data

The Save Data API provides comprehensive functions for managing game save data on the PlayStation 3.

Main Save Functions

sysSaveListLoad2

Load save data with list selection dialog.

s32 sysSaveListLoad2(u32 version,
    sysSaveListSettings *listSettings,
    sysSaveBufferSettings *bufferSettings,
    sysSaveListCallback listCb,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

version

u32

Version number, use SYS_SAVE_CURRENT_VERSION (0).

listSettings

sysSaveListSettings*

List display settings (sorting, filtering).

bufferSettings

sysSaveBufferSettings*

Buffer configuration for save data.

listCb

sysSaveListCallback

Callback for list operations.

statusCb

sysSaveStatusCallback

Callback for status operations.

fileCb

sysSaveFileCallback

Callback for file operations.

container

sys_mem_container_t

Memory container ID.

user_data

void*

User data passed to callbacks.

return

s32

Returns:

SYS_SAVE_RETURN_DONE (0) - Success
SYS_SAVE_RETURN_CANCELED (1) - User canceled
SYS_SAVE_RETURN_ERROR_* - Various error codes

sysSaveListSave2

Save data with list selection dialog.

s32 sysSaveListSave2(u32 version,
    sysSaveListSettings *listSettings,
    sysSaveBufferSettings *bufferSettings,
    sysSaveListCallback listCb,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

Parameters are identical to sysSaveListLoad2. Opens a save dialog allowing the user to select where to save.

sysSaveAutoLoad2

Automatically load from a specific save directory.

s32 sysSaveAutoLoad2(s32 version,
    const char *directoryName,
    sysSaveErrorDialogMode errorDialogMode,
    sysSaveBufferSettings *bufferSettings,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

version

s32

Version number, use SYS_SAVE_CURRENT_VERSION (0).

directoryName

const char*

Save directory name (max 32 characters).

errorDialogMode

sysSaveErrorDialogMode

Error dialog display mode:

SYS_SAVE_ERROR_DIALOG_NONE (0) - No error dialog
SYS_SAVE_ERROR_DIALOG_SHOW (1) - Show error dialog
SYS_SAVE_ERROR_DIALOG_SHOW_ONCE (2) - Show error dialog once

bufferSettings

sysSaveBufferSettings*

Buffer configuration.

statusCb

sysSaveStatusCallback

Status callback function.

fileCb

sysSaveFileCallback

File operation callback.

container

sys_mem_container_t

Memory container ID.

user_data

void*

User data for callbacks.

return

s32

Returns status code.

sysSaveAutoSave2

Automatically save to a specific directory.

s32 sysSaveAutoSave2(s32 version,
    const char *directoryName,
    sysSaveErrorDialogMode errorDialogMode,
    sysSaveBufferSettings *bufferSettings,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

Parameters are identical to sysSaveAutoLoad2. Saves without showing a dialog.

sysSaveFixedLoad2

Load from a fixed save location.

s32 sysSaveFixedLoad2(u32 version,
    sysSaveListSettings *listSettings,
    sysSaveBufferSettings *bufferSettings,
    sysSaveFixedCallback fixedCb,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

sysSaveFixedSave2

Save to a fixed location.

s32 sysSaveFixedSave2(u32 version,
    sysSaveListSettings *listSettings,
    sysSaveBufferSettings *bufferSettings,
    sysSaveFixedCallback fixedCb,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

sysSaveListAutoLoad

Load with automatic list handling.

s32 sysSaveListAutoLoad(u32 version,
    sysSaveErrorDialogMode errorDialogMode,
    sysSaveListSettings *listSettings,
    sysSaveBufferSettings *bufferSettings,
    sysSaveFixedCallback fixedCb,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

sysSaveListAutoSave

Save with automatic list handling.

s32 sysSaveListAutoSave(u32 version,
    sysSaveErrorDialogMode errorDialogMode,
    sysSaveListSettings *listSettings,
    sysSaveBufferSettings *bufferSettings,
    sysSaveFixedCallback fixedCb,
    sysSaveStatusCallback statusCb,
    sysSaveFileCallback fileCb,
    sys_mem_container_t container,
    void *user_data);

sysSaveDelete2

Delete save data.

s32 sysSaveDelete2(sys_mem_container_t container);

container

sys_mem_container_t

Memory container ID.

return

s32

Returns status code.

Data Structures

sysSaveListSettings

List display settings.

typedef struct {
    sysSaveSortType sortType;
    sysSaveSortOrder sortOrder;
    char *pathPrefix;
    void *reserved;
} sysSaveListSettings;

sortType

sysSaveSortType

Sort type:

SYS_SAVE_SORT_TYPE_TIMESTAMP (0) - Sort by timestamp
SYS_SAVE_SORT_TYPE_TITLE (1) - Sort by title

sortOrder

sysSaveSortOrder

Sort order:

SYS_SAVE_SORT_ORDER_DESCENDING (0) - Descending order
SYS_SAVE_SORT_ORDER_ASCENDING (1) - Ascending order

pathPrefix

char*

Path prefix filter for save directories.

sysSaveBufferSettings

Buffer configuration.

typedef struct {
    u32 maxDirectories;
    u32 maxFiles;
    u32 reserved[6];
    u32 bufferSize;
    void *buffer;
} sysSaveBufferSettings;

maxDirectories

u32

Maximum number of save directories.

maxFiles

u32

Maximum number of files per save.

bufferSize

u32

Size of the buffer in bytes.

buffer

void*

Pointer to buffer memory.

sysSaveCallbackResult

Callback result structure.

typedef struct {
    s32 result;
    u32 incrementProgress;
    s32 missingSpaceKB;
    char *customErrorMessage;
    void *user_data;
} sysSaveCallbackResult;

result

s32

Result code:

SYS_SAVE_CALLBACK_RESULT_DONE (1) - Operation complete
SYS_SAVE_CALLBACK_RESULT_CONTINUE (0) - Continue processing
SYS_SAVE_CALLBACK_RESULT_NO_SPACE_LEFT (-1) - No space
SYS_SAVE_CALLBACK_RESULT_ERROR (-2) - Error
SYS_SAVE_CALLBACK_RESULT_CORRUPTED (-3) - Data corrupted
SYS_SAVE_CALLBACK_RESULT_NOT_FOUND (-4) - Not found
SYS_SAVE_CALLBACK_RESULT_ERROR_CUSTOM (-5) - Custom error

incrementProgress

u32

Progress bar increment value.

missingSpaceKB

s32

Missing space in kilobytes (for no space errors).

customErrorMessage

char*

Custom error message to display (max 256 chars).

sysSaveSystemFileParam

Save data metadata.

typedef struct {
    char title[SYS_SAVE_MAX_TITLE];
    char subtitle[SYS_SAVE_MAX_SUBTITLE];
    char detail[SYS_SAVE_MAX_DETAIL];
    u32 copyProtected;
    u32 parentalLevel;
    char listParameter[SYS_SAVE_MAX_LIST_PARAMETER];
    u8 reserved[256];
} sysSaveSystemFileParam;

title

char[128]

Save data title.

subtitle

char[128]

Save data subtitle.

detail

char[1024]

Detailed description.

copyProtected

u32

Copy protection flag.

parentalLevel

u32

Parental control level.

sysSaveStatusIn

Input parameters for status callback.

typedef struct {
    s32 freeSpaceKB;
    u32 isNew;
    sysSaveDirectoryStatus directoryStatus;
    sysSaveSystemFileParam getParam;
    u32 bindingInformation;
    s32 sizeKB;
    s32 systemSizeKB;
    u32 totalFiles;
    u32 numFiles;
    sysSaveFileStatus *fileList;
    u8 reserved[64];
} sysSaveStatusIn;

freeSpaceKB

s32

Free space available in kilobytes.

isNew

u32

Whether this is a new save (1) or existing (0).

bindingInformation

u32

Binding information flags:

SYS_SAVE_BIND_NO_ERROR (0x00)
SYS_SAVE_BIND_ANOTHER_CONSOLE (0x01)
SYS_SAVE_BIND_ANOTHER_DISC (0x02)
SYS_SAVE_BIND_ANOTHER_APP (0x04)
SYS_SAVE_BIND_NO_USER_INFO (0x08)
SYS_SAVE_BIND_OTHER_USER (0x10)

sizeKB

s32

Total save data size in kilobytes.

totalFiles

u32

Total number of files in save data.

sysSaveStatusOut

Output parameters for status callback.

typedef struct {
    sysSaveSystemFileParam *setParam;
    sysSaveRecreateMode recreateMode;
    void *reserved;
} sysSaveStatusOut;

setParam

sysSaveSystemFileParam*

Metadata to write to save data.

recreateMode

sysSaveRecreateMode

Recreate mode if corrupted:

SYS_SAVE_RECREATE_MODE_OVERWRITE_CORRUPTED (0)
SYS_SAVE_RECREATE_MODE_OVERWRITE_NOT_CORRUPTED (1)
SYS_SAVE_RECREATE_MODE_DELETE (2)

sysSaveFileOut

File operation parameters.

typedef struct {
    sysSaveFileOperation fileOperation;
    void *reserved;
    sysSaveFileType fileType;
    u8 protectedFileID[SYS_SAVE_MAX_PROTECTED_FILE_ID];
    char *filename;
    u32 offset;
    u32 size;
    u32 bufferSize;
    void *buffer;
} sysSaveFileOut;

fileOperation

sysSaveFileOperation

Operation to perform:

SYS_SAVE_FILE_OPERATION_READ (0) - Read file
SYS_SAVE_FILE_OPERATION_WRITE (1) - Write file
SYS_SAVE_FILE_OPERATION_DELETE (2) - Delete file

fileType

sysSaveFileType

Type of file:

SYS_SAVE_FILETYPE_PROTECTED_FILE (0) - Protected file
SYS_SAVE_FILETYPE_STANDARD_FILE (1) - Standard file
SYS_SAVE_FILETYPE_CONTENT_ICON0 (2) - Icon 0
SYS_SAVE_FILETYPE_CONTENT_ICON1 (3) - Icon 1
SYS_SAVE_FILETYPE_CONTENT_PIC1 (4) - Picture 1
SYS_SAVE_FILETYPE_CONTENT_SND0 (5) - Sound 0

filename

char*

Filename (max 13 characters).

offset

u32

File offset for read/write.

size

u32

Number of bytes to read/write.

buffer

void*

Data buffer.

Callback Types

sysSaveListCallback

typedef void (*sysSaveListCallback)(
    sysSaveCallbackResult *result,
    sysSaveListIn *in,
    sysSaveListOut *out
);

sysSaveStatusCallback

typedef void (*sysSaveStatusCallback)(
    sysSaveCallbackResult *result,
    sysSaveStatusIn *in,
    sysSaveStatusOut *out
);

sysSaveFileCallback

typedef void (*sysSaveFileCallback)(
    sysSaveCallbackResult *result,
    sysSaveFileIn *in,
    sysSaveFileOut *out
);

sysSaveFixedCallback

typedef void (*sysSaveFixedCallback)(
    sysSaveCallbackResult *result,
    sysSaveListIn *in,
    sysSaveFixedOut *out
);

Constants

Show Size Limits

SYS_SAVE_MAX_DIRECTORY_NAME (32) - Max directory name length
SYS_SAVE_MAX_FILE_NAME (13) - Max filename length
SYS_SAVE_DIRECTORY_LIST_MAX (2048) - Max directories in list
SYS_SAVE_CUSTOM_ERROR_MESSAGE_MAX (256) - Max custom error message
SYS_SAVE_MAX_LIST_PARAMETER (8) - Max list parameter size
SYS_SAVE_MAX_TITLE (128) - Max title length
SYS_SAVE_MAX_SUBTITLE (128) - Max subtitle length
SYS_SAVE_MAX_DETAIL (1024) - Max detail length
SYS_SAVE_MAX_PROTECTED_FILE_ID (16) - Max protected file ID size

Example Usage

#include <sysutil/save.h>
#include <string.h>

#define SAVE_DIR "SAVEDATA01"
#define BUFFER_SIZE (512 * 1024)  // 512 KB

static u8 saveBuffer[BUFFER_SIZE];
static u8 fileBuffer[32 * 1024];  // 32 KB for game data

void statusCallback(sysSaveCallbackResult *result,
                    sysSaveStatusIn *in,
                    sysSaveStatusOut *out) {
    // Set save metadata
    static sysSaveSystemFileParam param;
    strcpy(param.title, "My Game Save");
    strcpy(param.subtitle, "Level 5");
    strcpy(param.detail, "Saved at checkpoint");
    param.copyProtected = 0;
    param.parentalLevel = 0;
    
    out->setParam = &param;
    out->recreateMode = SYS_SAVE_RECREATE_MODE_OVERWRITE_CORRUPTED;
    
    result->result = SYS_SAVE_CALLBACK_RESULT_CONTINUE;
}

void fileCallback(sysSaveCallbackResult *result,
                  sysSaveFileIn *in,
                  sysSaveFileOut *out) {
    // Write game data
    out->fileOperation = SYS_SAVE_FILE_OPERATION_WRITE;
    out->fileType = SYS_SAVE_FILETYPE_STANDARD_FILE;
    out->filename = "GAMEDATA.BIN";
    out->offset = 0;
    out->size = sizeof(fileBuffer);
    out->buffer = fileBuffer;
    out->bufferSize = sizeof(fileBuffer);
    
    result->result = SYS_SAVE_CALLBACK_RESULT_DONE;
}

int main() {
    sys_mem_container_t container;
    sysSaveBufferSettings bufferSettings;
    
    // Configure buffer
    bufferSettings.maxDirectories = 10;
    bufferSettings.maxFiles = 5;
    bufferSettings.bufferSize = BUFFER_SIZE;
    bufferSettings.buffer = saveBuffer;
    
    // Save game data
    s32 ret = sysSaveAutoSave2(
        SYS_SAVE_CURRENT_VERSION,
        SAVE_DIR,
        SYS_SAVE_ERROR_DIALOG_SHOW,
        &bufferSettings,
        statusCallback,
        fileCallback,
        container,
        NULL
    );
    
    if (ret == SYS_SAVE_RETURN_DONE) {
        printf("Save successful!\n");
    } else if (ret == SYS_SAVE_RETURN_CANCELED) {
        printf("Save canceled\n");
    } else {
        printf("Save error: 0x%x\n", ret);
    }
    
    return 0;
}

Graphics APIs

Input APIs

Audio APIs

Network APIs

System APIs

System Utility APIs

Media APIs

Device APIs

SPU APIs

Math Libraries

Main Save Functions

sysSaveListLoad2

sysSaveListSave2

sysSaveAutoLoad2

sysSaveAutoSave2

sysSaveFixedLoad2

sysSaveFixedSave2

sysSaveListAutoLoad

sysSaveListAutoSave

sysSaveDelete2

Data Structures

sysSaveListSettings

sysSaveBufferSettings

sysSaveCallbackResult

sysSaveSystemFileParam

sysSaveStatusIn

sysSaveStatusOut

sysSaveFileOut

Callback Types

sysSaveListCallback

sysSaveStatusCallback

sysSaveFileCallback

sysSaveFixedCallback

Constants

Example Usage

Build docs developers (and LLMs) love

Graphics APIs

Input APIs

Audio APIs

Network APIs

System APIs

System Utility APIs

Media APIs

Device APIs

SPU APIs

Math Libraries

​Main Save Functions

​sysSaveListLoad2

​sysSaveListSave2

​sysSaveAutoLoad2

​sysSaveAutoSave2

​sysSaveFixedLoad2

​sysSaveFixedSave2

​sysSaveListAutoLoad

​sysSaveListAutoSave

​sysSaveDelete2

​Data Structures

​sysSaveListSettings

​sysSaveBufferSettings

​sysSaveCallbackResult

​sysSaveSystemFileParam

​sysSaveStatusIn

​sysSaveStatusOut

​sysSaveFileOut

​Callback Types

​sysSaveListCallback

​sysSaveStatusCallback

​sysSaveFileCallback

​sysSaveFixedCallback

​Constants

​Example Usage

Build docs developers (and LLMs) love

Main Save Functions

sysSaveListLoad2

sysSaveListSave2

sysSaveAutoLoad2

sysSaveAutoSave2

sysSaveFixedLoad2

sysSaveFixedSave2

sysSaveListAutoLoad

sysSaveListAutoSave

sysSaveDelete2

Data Structures

sysSaveListSettings

sysSaveBufferSettings

sysSaveCallbackResult

sysSaveSystemFileParam

sysSaveStatusIn

sysSaveStatusOut

sysSaveFileOut

Callback Types

sysSaveListCallback

sysSaveStatusCallback

sysSaveFileCallback

sysSaveFixedCallback

Constants

Example Usage