JCL Help:NtfsFindStreamClose
JCL Help: NtfsFindStreamClose Function
Search in JCL Help
Search in all projects
Summary
Terminates the enumeration of streams.
Pascal
function NtfsFindStreamClose(var Data: TFindStreamData): Boolean;
Parameters
| Parameters | Description |
| var Data: TFindStreamData | The TFindStreamData record returned from NtfsFindFirstStream. |
Return Value
If the function succeeds it returns True, otherwise it returns False. In the latter case you can call GetLastError to retrieve the reason of failure.
Description
NtfsFindStreamClose terminates the enumeration of streams in a file initiated with NtfsFindFirstStream and releases all context resources stored in the Data parameter. It's important that if a previous call to NtfsFindFirstStream succeeds, you eventually call this function regardless of what happens in the remainder of the enumeration.
See Also
NtfsFindFirstStream NtfsFindNextStream TFindStreamData
About
Unit
Donator
Marcel van Brakel
Notes
Note that if NtfsFindFirstStream fails there's no need to call this function because NtfsFindFirstStream performs the necessary cleanup. It is however, harmless to call this function anyway (though it will fail and GetLastError will return ERROR_INVALID_HANDLE).
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
