GetProperty

nn::boss::DataStoreUploadAction::GetProperty Member Function

Syntax

virtual nn::Result GetProperty(
     PropertyType type,
     void * pValue,
     size_t size
);

Parameters

Name Description
in type Specifies the property identifier.
out pValue Specifies the value.
in size Specifies the value size.

Return Values

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

Value Description
Result::IsSuccess Retrieval successful.
ResultInvalidPropertyValue The property value pointer is NULL.
ResultInvalidPropertyType The property type is not supported.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Gets a property value from the class.

It can be used for the following properties. Call this function after allocating memory for the description's data type.
Identifier Description
Type code for ACTION_CODE tasks. The data type is Action. ACTION_FILEDESC The file identifier type. The data type is FileDescriptor. ACTION_DATASTORE_GAME_ID ID used to identify the game server. The data type is u32. ACTION_DATASTORE_ACCESS_KEY Key used to access the game server. The data type is wchar_t[MAX_ACCESS_KEY_LENGTH]. ACTION_DATASTORE_UPLOAD_PERIOD The number of days until data is deleted automatically. The data type is u16. ACTION_DATASTORE_UPLOAD_DATA_TYPE A value indicating the data type. The data type is u16. ACTION_DATASTORE_UPLOAD_DST_PRINCIPAL_ID_NUM The number of settings made for message data send destinations. The data type is u16. ACTION_DATASTORE_UPLOAD_DST_KIND The message data send destination type. The data type is DstKind. ACTION_DATASTORE_UPLOAD_DST_PRINCIPAL_ID The message data send destination ID. The data type is u32[MAX_DST_PRINCIPAL_ID].

Revision History

2011/10/27
Initial version.

CONFIDENTIAL