Microsoft SDK for Java

purgeExpendableFiles

The purgeExpendableFiles method of the ClientStore Class contains the following signatures:

purgeExpendableFiles(long spacerequired, int flags)
purgeExpendableFiles(long spacerequired)
purgeExpendableFiles()

purgeExpendableFiles(long spacerequired, int flags)

Searches for files that are marked as expendable. If files are found and the total space used by the found files exceeds spacerequired, the found files are deleted. A file can be marked expendable by using the markFileAsExpendable method or by creating the file with the OPEN_FL_EXPENDABLE flag.

Syntax

public boolean purgeExpendableFiles(long spacerequired, int flags) throws IOException;

Return Value

Returns true if files were deleted; otherwise, returns false.

Parameters

spacerequired The number of bytes needed. If spacerequired is set to 0, all the files marked as expendable are deleted.
flags A value that indicates the storage area from which to delete stgfilename. It can be either or both of the STORE_FL_LOCAL and STORE_FL_ROAMING flags.

Exceptions

IOException if an error occurs while deleting the files.

purgeExpendableFiles(long spacerequired)

Searches for files that are marked as expendable. If files are found and the total space used by the found files exceeds spacerequired, the found files are deleted. A file can be marked expendable by using the markFileAsExpendable method or by creating the file with the OPEN_FL_EXPENDABLE flag.

Syntax

public boolean purgeExpendableFiles(long spacerequired) throws IOException;

Return Value

Returns true if files were deleted; otherwise, returns false.

Parameters

spacerequired The number of bytes needed. If spacerequired is set to 0, all the files found are deleted.

Exceptions

IOException if an error occurs while deleting the files.

purgeExpendableFiles()

Deletes all files that are marked as expendable. Files are marked expendable by using the markFileAsExpendable method or by creating them with the OPEN_FL_EXPENDABLE flag.

Syntax

public boolean purgeExpendableFiles() throws IOException;

Return Value

Returns true if files were deleted; otherwise, returns false.

Exceptions

IOException if an error occurs while deleting the files.

© 1999 Microsoft Corporation. All rights reserved. Terms of use.