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

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

	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	fileHandle	Specifies the handle of the file to be uploaded.
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.)

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).

Use to configure the settings attached to the DataStore upload file handle.

Special version for configuring the file handle. Normally you should use Initialize in the following way. Initialize(u32 gameId, const wchar_t* pAccessKey, DstKind dstKind, u16 dataType, u16 period)
Even if the DataStoreUploadAction::Initialize function has already been run on an object, this function can be re-run to allow the object to be reused.

2011/10/27

Initial version.