DataFolder.uploadFile Method
Parent Object:
DataFolderDefined in namespace "adsk::core" and the header file is <Core/Dashboard/DataFolder.h>
Description
Uploads a single file to this directory.
Remarks
Uploading a file is not supported within any of the Command related events. When a command is running, a transaction is open, and uploading files cannot be transacted and, as a result, cannot be contained within a command transaction.
Syntax
"dataFolder_var" is a variable referencing a DataFolder object.returnValue = dataFolder_var.uploadFile(filename) |
"dataFolder_var" is a variable referencing a DataFolder object.
#include <Core/Dashboard/DataFolder.h>
returnValue = dataFolder_var->uploadFile(filename);
|
Return Value
| DataFileFuture |
The upload process is asynchronous which means that this method will return before the upload process had completed. The returned DataFileFuture object can be used to check on the current state of the upload to determine if it is still uploading, is complete, or has failed. If it is complete the final DataFinal can be retrieved through the DataFileFuture object. |
Parameters
| filename |
string |
The full filename of the file to upload. |
Version
Introduced in version March 2015
