GetRanges Method

Gets the list of allocated data ranges in a file.

Syntax

int GetRanges(const QString& qsFilePath);

Remarks

This method gets the list of allocated data ranges in the file at the specified FilePath in the share currently selected by Share and populates the Range* properties with the results.

The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file; thus, the size of every range returned by this method will always be a multiple of 512. Chunks that are not currently allocated (either because no data has been written to them, or because they've been freed with ClearRange) will not be returned by this method.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)