GetProperty

nn::boss::DataStoreDownloadAction::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_DOWNLOAD_NEWS_SUBJECT The subject title of notification data. The data type is wchar_t[MAX_NEWS_SUBJECT_LENGTH]. ACTION_DATASTORE_DOWNLOAD_NEWS_MESSAGE The body of notification data. The data type is wchar_t[MAX_NEWS_MESSAGE_LENGTH]. ACTION_DATASTORE_DOWNLOAD_NEWS_JUMP_PARAM General-purpose notification data jump parameter. The data type is u8[MAX_NEWS_PARAM]. ACTION_DATASTORE_DOWNLOAD_NEWS_MODE Toggle for issuing notification data. The data type is NewsMode. ACTION_DATASTORE_DOWNLOAD_NEWS_SERIAL_ID Notification data serial ID. The data type is bit 32.

Revision History

2011/10/27
Initial version.

CONFIDENTIAL