nn::boss::TaskActionBase::SetFileProperty Member Function

Syntax

protected:
nn::Result SetFileProperty(
PropertyType type,
void * pValue,
size_t size
);

Arguments

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
ResultSuccess Set successfully.
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 details).

Description

Gets a property value from the class. Call this function after allocating memory for the description's data type. It can be used for the following properties.
Identifier: Description
ACTION_OFFSET: The offset from the starting position of the data specified by the URL. The data type is u32.
ACTION_FILEPATH: Local path to the file being downloaded. The data type is char[MAX_FILEPATH_LENGTH].
ACTION_FILEPATH_W: Local path to the file being downloaded. The data type is wchar_t[MAX_FILEPATH_LENGTH].
ACTION_FILE_HANDLE: File handle to the file being downloaded. The data type is nnHandle.

Revision History

2010/11/10
Initial version.

CONFIDENTIAL