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

Syntax

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

Arguments

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
ResultSuccess Read successfully.
ResultInvalidNsDataValue The pointer to the region that stores NSDATA is NULL.
ResultNsDataNotFound The specified NS data is not found. Might have been deleted with an auto-delete.
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 permission to access storage. Cannot access the expanded save region. Re-confirm whether you have access rights.
ResultIpcNotSessionInitialized Either a session had not been initialized or there were incompatible permissions. This Result is returned if this function is called before either the Initialize or the InitializePriviledged function is called. When using the BOSS library, always begin by calling either the Initialize or the InitializePriviledged function.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Reads NS archive header information. When the following types of NSA header information are specified, you can get the corresponding values. At that time, you will need to have allocated the necessary memory. When less than the necessary memory is available, the ResultInvalidNsDataGetHeadSize error is returned. NSD_TITLEID: a 64-bit title ID. (s64) NSD_FLAGS: The NSD flag. (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) Note that the specified NS data file might not be found, such as if the file was auto-deleted or if there was not enough space available when downloading the NS archive.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL