nn::boss::GetOwnNsDataIdList Function

Syntax

nn::Result GetOwnNsDataIdList(
     u32 dataType,
     NsDataIdList * pNsDataId
);

Arguments

Name Description
in dataType Specifies the data type. (Use DATA_TYPE_ALL to specify all data types. Note that this excludes the data type for Notifications because this data cannot be obtained from the application.)
out pNsDataId Specifies an object storing a list of NS data.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Retrieval successful.
ResultNsDataListSizeShortage Because the size of NsDataIdList was insufficient, not all NS data serial IDs could be stored.
Continue and call repeatedly until all NS data serial IDs are obtained.
ResultNsDataListUpdated The target NSD group for BOSS storage was updated since the last time a list was obtained.
ResultInvalidNsDataIdList The pointer to NS data list information is NULL.
ResultStorageNotFound The BOSS storage corresponding to the appropriate application ID is not registered. Please check if the BOSS storage is registered.
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 before using the BOSS library.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Excludes the shared NS data and gets the application's list of NS content from the expanded save data region where the BOSS storage is registered.

In other words, only NS data for the invoked application is included in the list, even if there is shared NS data.

The return value is ER_NSDATA_LIST_SIZE_SHORTAGE if the entire list could not be obtained.
If you call this function more than once and an update in the list's content, such as a new download, is detected, ER_NSDATA_LIST_UPDATED is returned and you must start over.
In this case, re-call this function after initializing the instance of NsDataIdList.

 

[How to use the dataType argument]

See GetNsDataIdList.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL