Difference between revisions of "Unit NTFSUtils"

Revision as of 05:43, 19 December 2016

@@ Line 4: / Line 4: @@
 === Description ===
 ----
+'''Ultibo NTFS utilities unit'''
 ''To be documented''

Buffer	Buffer must always be a full compression unit in size
Size	Size is the size of a cluster
Shift	Shift is the cluster to compression unit shift count (Usually 4)
Note	Caller must have confirmed that the unit is compressed

Source	Source buffer contains the uncompressed data on entry Source buffer must always be a full compression unit in size
Dest	Dest buffer will contain the compressed data on exit Dest buffer must always be a full compression unit in size
Size	Size is the size of a cluster
Shift	Shift is the cluster to compression unit shift count (Usually 4)
Start	Start is the starting cluster for the compression (zero to start at the first cluster)
Count	Count is the number of clusters to be compressed
Total	Total is the number of bytes to be compressed (from start) (may be less than a full unit)
Note	Compress block will detect an uncompressable block as the final length after compression will be greater than 4096 in length. If compress block reaches the end of the dest buffer then it will fail the compress block and compress unit and the whole unit will be considered as uncompressable. If the data available for the block is less then 4096 then it may grow after compression but will not be marked as uncompressed unless it exceeds 4096 bytes.

Source	Source buffer contains the compressed data on entry Source buffer must always be a full compression unit in size
Dest	Dest buffer will contain the uncompressed data on exit Dest buffer must always be a full compression unit in size
Size	Size is the size of a cluster
Shift	Shift is the cluster to compression unit shift count (Usually 4)
Start	Start is the starting cluster for the decompression (zero to start at the first cluster)
Count	Count is the number of blocks to be decompressed
Total	Total is the number of bytes to be decompressed (from start) (may be less than a full unit)
Note	Caller must have confirmed that the unit is compressed

Source	Source buffer contains the uncompressed data on entry Source buffer must have at least one 4k block available
Dest	Dest buffer will contain the compressed data on exit
Size	Size is the available bytes in the dest buffer
Total	Total is the number of bytes to be compressed (may be less than a full block)
Note	Compress block will detect an uncompressable block as the final length after compression will be greater than 4096 in length. If compress block reaches the end of the dest buffer then it will fail the compress block and compress unit and the whole unit will be considered as uncompressable. If the data available for the block is less then 4096 then it may grow after compression but will not be marked as uncompressed unless it exceeds 4096 bytes.

Size	Size is the length of the Name in characters (WideChar or Word)
UpCase	UpCase is the UpCase conversion table from NTFS volume or defaults