nn::boss::TaskActionBase::GetFileProperty Member Function

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

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

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

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
ACTION_OFFSET: The offset from the starting position of the data specified by the URL. The data type is u32.
ACTION_FILEPATH The file path targeted by the task. The data type is char[MAX_FILEPATH_LENGTH].
ACTION_FILEPATH_W The file path targeted by the task. The data type is wchar_t[MAX_FILEPATH_LENGTH].
ACTION_FILEPATH_HANDLE The file handle targeted by the task. The data type is nnHandle.

2010/11/10

Initial version.