CBFS Storage 2020 Node.js Edition

Questions / Feedback?

GetFileSize Method

Retrieves the size of a file or alternate stream.

Syntax

cbmemdrive.getFileSize(fileName, [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 retrieves the size, in bytes, of the file or alternate stream specified by FileName. (Note that, for files, the returned value only reflects the size of the file's immediate contents, it does not account for any alternate streams the file may or may not contain.)

The value passed for FileName must be a vault-local absolute path.

Note: This method can only be called when Active is true.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 Node.js Edition - Version 20.0 [Build 7986]