JCL Help:NtfsSetSparse

 JCL Help: NtfsSetSparse Function

FilesandIO.FileSystems.NTFS

JEDI Code Library Help

• Packages
  • RTL enhancements
  • Containers
  • Developer Tools
  • VCL enhancements
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JCL Help

 

Search in all projects

 

Summary

Sets the sparse file attribute.

Pascal

 function NtfsSetSparse(const FileName: string): Boolean;

Parameters

Parameters	Description
const FileName: string	The file to make into a sparse file.

Return Value

If the function succeeds the return value is True, otherwise it's False.

Description

NtfsSetSparse makes the specified file a sparse file. A sparse file is a normal file but one which only uses disk space for those portions of the file that actually contain data. This however is not automatic, see the other NtfsXxxx functions and the Platform SDK for details. Keep in mind that no storage is decommited until you call NtfsZeroDataByHandle or NtfsZeroDataByName.

See Also

NtfsGetSparse NtfsZeroDataByHandle NtfsZeroDataByName

About

Unit

JclNTFS

Donator

Marcel van Brakel

Notes

Sparse files are only supported by NTFS version 5.0 and higher.

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Code Library source code is hosted at : link to view the current source code, link to the subversion repository