Skip to content

setSparse

xiao edited this page Nov 8, 2025 · 1 revision

add sparse attribute to a file on a NTFS Volume.

usage

callback:

fswin.ntfs.setSparse(file, callback, [create]);

async:

var succeeded = await fswin.ntfs.setSparseAsync(file, [create]);

sync:

var succeeded = fswin.ntfs.setSparseSync(file, [create]);
  • file is a string that specifies a file.
  • callback is a function that takes only one argument succeeded.
  • create is a boolean value to determine whether to create an new file when file does not exist.
  • succeeded is a boolean value to indicate whether the operation is succeeded.

example

var fswin = require('fswin');
var file = 'd:\\test';

//sync
console.log(fswin.ntfs.setSparseSync(file) ? 'succeeded' : 'failed');

//async
console.log(fswin.ntfs.setSparse(file, function (succeeded) {
	console.log(succeeded ? 'succeeded' : 'failed');
}) ? 'job queued' : 'failed to queue job');

Clone this wiki locally