CreateFile Method

Initializes a new file.

Syntax

azurefile.createFile(newFilePath, fileLength, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method initializes a new file with a given FileLength (in bytes) at the specified NewFilePath in the share currently selected by Share. The path of the newly-initialized file is returned.

Any parent folders included in NewFilePath must already exist.

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata* properties will be sent along with the creation request.

Note: This method is typically only useful for advanced use-cases. To upload a file, just call UploadFile.

Usage Notes

This method does not upload or otherwise allocate any data, it just creates the file entry and "reserves" storage space for it. After a file has been created with this method, the following methods can be used to manipulate its data:

• The PutRange method can be used to upload ranges of data (up to 4MB at once) to the file.
• The ClearRange method can be used to clear an arbitrary range of data from the file, allowing the server to release the associated storage resources.
• The GetRanges method can be used to obtain a list of all data ranges present in the file.