CloseOpenedFilesSnapshot Method

Closes the previously-created opened files snapshot.

Syntax

• C++

ANSI (Cross Platform)
int CloseOpenedFilesSnapshot();

Unicode (Windows)
INT CloseOpenedFilesSnapshot();

#define MID_CBFS_CLOSEOPENEDFILESSNAPSHOT 5

CBFSCONNECT_EXTERNAL int CBFSCONNECT_CALL CBFSConnect_CBFS_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method closes the opened files snapshot previously created by CreateOpenedFilesSnapshot, releasing the memory associated with it. Please refer to that method's documentation for more information.

Note: This method cannot be called within events.

The methods and properties related to open files snapshots are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that creation, use, and cleanup of open files snapshots occurs in a thread-safe manner.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)