nn::boss::DataStoreUploadAction::Initialize Member Function

Syntax

nn::Result Initialize(
     u32 gameId,
     const wchar_t * pAccessKey,
     DstKind dstKind,
     u16 dataType,
     u16 period
);

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 use more than 8 characters. See the NEX library documentation for details.)
in dstKind Specifies the message data send destination type. (For more details, see the documentation in the NEX library.)
in dataType Specifies a value indicating the data type.
in period Specifies the number of days until data is automatically deleted. (For more details, see the documentation in the NEX library.)

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

Used to configure DataStore upload.

When registering tasks, use the following functions. For normal execution: nn::Result RegisterTask(Task* pTask, TaskPolicy* pPolicy, TaskAction* pAction, const char* pFilePath, TaskOption* pOption=NULL, u8 taskStep=DEFAULT_STEP_ID). For immediate execution: nn::Result RegisterImmediateTask(Task* pTask, TaskAction* pAction, const char* pFilePath, TaskPolicy* pPolicy=NULL, TaskOption* pOption=NULL, u8 taskStep=DEFAULT_STEP_ID);.

Revision History

2011/10/27
Initial version.

CONFIDENTIAL