nn::boss::DataStoreDownloadAction::Initialize Member Function

Syntax

nn::Result Initialize(
     u32 gameId,
     const wchar_t * pAccessKey
);

Parameters

Name Description
in gameId Specifies the ID used to identify game servers. (For more details, see the documentation in the NEX library.)
in pAccessKey Specifies the key used to access the game server. (Do not denote more than 8 characters. See the NEX library documentation for details.)

Return Values

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

Value Description
Result::IsSuccess Initialization successful.
ResultInvalidPointer The pointer to the access key character string is NULL.
ResultInvalidSize The access key string length is 0 or exceeds the maximum number of characters allowed.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Configures DataStore download tasks.

Even if the DataStoreDownloadAction::Initialize function has already been run on an object, this function can be re-run to allow the object to be reused.

Revision History

2011/10/27
Initial version.

CONFIDENTIAL