Share via


FbwfFindFirstEx (Standard 7 SP1)

7/8/2014

This function returns the first entry of the files and folders that are currently cached by the write filter. The caller provides a volume path and the buffer to hold cache detail with its size specified in CacheDetailSize.

When the function succeeds, the function updates the value pointed by this parameter to the size of CacheDetail.

When the buffer is too small ERROR_INSUFFICIENT_BUFFER is returned and the value pointed by CacheDetailSize is updated to the size required to hold the first entry.

If the function succeeds, the return value is a search handle that is used in a later call to FbwfFindNextEx or FbwfFindCloseEx, and the CacheDetail parameter contains information about the first file or directory found.

If the function fails because no files are in the overlay, it returns ERROR_NO_MORE_FILES.

Syntax

ULONG WINAPI FbwfFindFirstEx(
   __in LPCWSTR VolumeName,
   __out_bcount(*CacheDetailSize) PFbwfCacheDetailEx CacheDetail,
   __inout PULONG CacheDetailSize,
   __out FBWF_FIND_FILE_HANDLE *FindHandle
);

Parameters

  • VolumeName
    [in] Null-terminated wide string that contains the name of the volume.
  • CacheDetail
    [out] Caller allocated buffer that contains the first cache detail.
  • CacheDetailSize
    [in, out] On input, contains the size of CacheDetail. If the function returns ERROR_MORE_DATA, size contains the size in bytes of the required buffer.
  • FindHandle
    [out] The search handle returned by the function.

Return Value

This function may return the following:

Return value

Description

ERROR_SUCCESS

The operation completed successfully.

ERROR_INSUFFICIENT_BUFFER

If the buffer is too small.

ERROR_NO_MORE_FILES

If there are no files are in the overlay.

Requirements

OS Versions: Standard 7

Header: Fbwfapi.h

Link Library: Fbwflib.lib

See Also

Reference

FbwfFindNextEx
FbwfFindCloseEx

Concepts

FBWF API