nn::boss::GetNsDataIdList Function

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

	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 content data.

Returns the function's execution result. Returns one of the Result values listed below.

Value	Description
ResultSuccess	Retrieval successful.
ResultNsDataListSizeShortage	Size of NsDataIdList is insufficient (could not store all the NSD serial IDs). Continue calling repeatedly until you get all the NSD serial IDs.
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	Storage has not been registered for the corresponding application ID. Confirm whether any storage has been registered yet.
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).

Specifies the data type and gets a list of NS content from the registered storage expanded save region.

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 it detects an update in the list's content, such as a new download, it returns ER_NSDATA_LIST_UPDATED and you must start over. In this case, re-call this function after initializing the instance of NsDataIdList.

Use of dataType parameter:
Specify DATA_TYPE_ALL to search all NS data.
In other cases, specify search targets using a bitwise OR of global data types and private data types.
Only IDs of NS data whose global data types match and whose private data types match the mask and are determined to be acquisition targets are stored in the list.

There are three global data types, as follows.
nn::boss::DATA_TYPE_APPDATA: Additional data
nn::boss::DATA_TYPE_NEWS: Data displayed in notifications (cannot be obtained by applications)
nn::boss::DATA_TYPE_EXBANNER DL: Contextual banner data

The private data type is a 16-bit value, which is treated as a mask value for the private data type of the NS data (lower-order 16 bits of data type).
If any of the bits set in the specified private data type are set in the private data type of the NS data
(i.e., if the bitwise AND of the private data types is non-zero), then that NS data item can be retrieved.
For example, to get all added data, specify DATA_TYPE_APPDATA | 0x0000FFFF as dataType.
Applications can use the data types of NS data to categorize added data proprietarily.

2010/09/16

Initial version.