Download

nn::boss::NsaList::Download Member Function

Syntax

nn::Result Download(
     const char * bossCode,
     const char * taskId,
     const SearchAttributes * attributes = NULL,
     u32 waitTimeoutSec = NN_BOSS_NSALIST_WAIT_FINISH_TIMEOUT_DEFAULT_SEC,
     s64 fileSize = NN_BOSS_NSALIST_MAX_SIZE
);

Parameters

Name Description
in bossCode BOSS code of the target task.
in taskId Task ID of the target task.
in attributes Attributes used for NSA searches. (May be omitted when not specifying attributes.)
in waitTimeoutSec Timeout for download processes. (The default value is applied if omitted. No timeout is set if 0 is specified.)
in fileSize The size of the NSA list file to create. (The function creates an empty file of this size, and then writes the NSA list to it. If this parameter is omitted, the maximum size of an NSA list (NN_BOSS_NSALIST_MAX_SIZE) is set. This function will return the error ResultNSAListDownloadTaskError if the size value is smaller than the downloaded NSA list.)

Return Values

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

Value Description
Result::IsSuccess Retrieval successful.
ResultWaitFinishTaskNotDone Task execution is stopped (TASK_STOPPED status). This result is returned when downloading the NSA list has been canceled.
ResultWaitFinishTimeout The WaitFinish function timed out.
ResultNSAListDownloadTaskError The result of the download task was an error.
ResultUnexpect An unexpected result code (result code for which an error code is not allocated) is passed.
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).

Description

Downloads the NSA list.

Revision History

2011/10/27
Initial version.

CONFIDENTIAL