`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.
S	`NN_BOSS_NSDATA_READ_ERROR_UPDATED`	NS data `ReadNsData` error definition. The target NS data version was updated since the last time data was obtained.

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: Sometimes the target NS data cannot be found due to one of the following: 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.
	`GetHeaderInfo`	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. When less than the necessary memory is available, the `ResultInvalidNsDataGetHeadSize` error is returned. `NSD_TITLEID`: 64-bit title ID. (`s64`) `NSD_FLAGS`: NS data flags. (`bit32`) `NSD_DATATYPE`: NS data type. (`bit32`) `NSD_LENGTH`: NS data length. (`s32`) `NSD_SERIALID`: NS data serial ID. (`u32`) `NSD_VERSION`: NS data version number. (`u32`) Note: 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 was automatically deleted.
	`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 it loads a large NSD, other applications are not blocked from loading NS data as long as the other applications do not try to access the same NS data. Note: An error will be returned if the target NS data cannot be found, whether it is because another application has already deleted the NS data, there was not enough space available when downloading the NS archive, or the data was automatically deleted. The function returns `NN_BOSS_NSDATA_READ_ERROR_UPDATED` in those rare instances where the specified NS data version has been updated since the last time the data was obtained. In such cases, call `Initialize` and then read the data again.
	`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. Note: The NS data additional information is information that can be freely used by the application, but this additional information is always initialized when a new version of the NS data is downloaded.
	`GetAdditionalInfo`	Gets additional information about the NS data. Note: The NS data additional information is information that can be freely used by the application, but this additional information is always 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