`nn::boss::NsData` Class

Syntax

class NsData

Description

Class for representing NS data. Use for NS data operations (such as reading).

Member Constants

S	`NN_BOSS_NSDATA_READ_ERROR_GET_HEADER`	NS data `ReadNsData` error definition. Failed to get the NS data header.
S	`NN_BOSS_NSDATA_READ_ERROR_READ_DATA`	NS data `ReadNsData` error definition. Failed to load NS data.
S	`NN_BOSS_NSDATA_READ_ERROR_IPC`	NS data `ReadNsData` error definition. An IPC error occurred.

Member Functions

	`NsData`	Constructor.
V	`~NsData`	Destructor.
	`Initialize`	Initializes NS data for the specified serial ID. (Running this function allows you to reuse instances that have been used before.)
	`Delete`	Deletes an NS data file. 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.
	`GetHeaderInfo`	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.
	`ReadData`	Reads an NS data file. The interface is similar to that of file access. After allocating an adequately sized buffer, call this function multiple times to read an entire NS data file. Returns `0` upon reaching end of file, indicating that the read is finished. An application can only load one NS data file at once, but even if a large NSD is loaded, as long as the same NS data is not accessed, it will not block other applications from loading NS data. Note that the specified NS data file might not be found and an error returned, such as if the file was auto-deleted or if there was not enough space available when downloading the NS archive.
	`SetReadDataPosition`	Changes the read position in an NS data file. The interface is similar to that of file access. See `PositionBase` for details on the base for changing the read position.
	`SetAdditionalInfo`	Sets additional information about the NS data. The added information for NS data is information that can be freely used by the application, but note that this added information will be be initialized when a new version of the NS data is downloaded.
	`GetAdditionalInfo`	Gets additional information about the NS data. The added information for NS data is information that can be freely used by the application, but note that this added information will be be initialized when a new version of the NS data is downloaded.
	`SetReadFlag`	Sets the read flag of the NS data. The application can set this, but note that the flag is reset to "unread" when a new version of the NS data file is downloaded.
	`GetReadFlag`	Gets the read flag of the NS data.
	`GetLastUpdated`	Gets the NS data file update timestamp. Note that the update timestamp records the time at which the update was actually downloaded.

Revision History

2010/09/16: Initial version.

CONFIDENTIAL