nn::boss::NsData::GetHeaderInfo Member Function

Syntax

nn::Result GetHeaderInfo(
     HeaderInfoType type,
     void * pValue,
     size_t size
);

Parameters

Name Description
in type Specifies the header element type.
out pValue Specifies a buffer storing the header information.
in size Buffer size.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Read successfully.
ResultInvalidNsDataValue The pointer to the region that stores NSDATA is NULL.
ResultNsDataNotFound The specified NS data is not found. It might have been automatically deleted.
ResultInvalidNsDataGetHeadSize The header size does not match the header type specified by the GetHeaderInfo function. Normally this doesn't occur, but it is possible that something abnormal occurred.
ResultStorageAccessPermission You do not have storage access rights. Cannot access the expanded save data region. Reconfirm your access rights.
ResultIpcNotSessionInitialized The session has not been initialized. This result is returned if this function is called before the Initialize function. Always call the Initialize function first thing when you use the BOSS library.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Reads NS archive header information.

Specify the following types of NS archive header information to get the corresponding values.
To do so, you must allocate the necessary memory in advance. The function returns a ResultInvalidNsDataGetHeadSize error when the required amount of memory is not available.

NSD_TITLEID: The 64-bit title ID. (s64)
NSD_FLAGS: NSD flags. (bit32)
NSD_DATATYPE: The NSD data type. (bit32)
NSD_LENGTH: The NSD length. (s32)
NSD_SERIALID: The NSD serial ID. (u32)
NSD_VERSION: The NSD version number. (u32)
NSD_ALL: All NSD attributes.… (NsDataHeaderInfo)

Note that sometimes the target NS data cannot be found, possibly because another application has already deleted the NS data, there was not enough space available when downloading the NS archive, or the data has been automatically deleted.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL