FindFirstFileNameW function (fileapi.h)

Creates an enumeration of all the hard links to the specified file. The FindFirstFileNameW function returns a handle to the enumeration that can be used on subsequent calls to the FindNextFileNameW function.

To perform this operation as a transacted operation, use the FindFirstFileNameTransactedW function.

Syntax

HANDLE FindFirstFileNameW(
  [in]      LPCWSTR lpFileName,
  [in]      DWORD   dwFlags,
  [in, out] LPDWORD StringLength,
  [in, out] PWSTR   LinkName
);

Parameters

[in] lpFileName

The name of the file.

[in] dwFlags

Reserved; specify zero (0).

[in, out] StringLength

The size of the buffer pointed to by the LinkName parameter, in characters. If this call fails and the error returned from the GetLastError function is ERROR_MORE_DATA (234), the value that is returned by this parameter is the size that the buffer pointed to by LinkName must be to contain all the data.

[in, out] LinkName

A pointer to a buffer to store the first link name found for lpFileName.

Return value

If the function succeeds, the return value is a search handle that can be used with the FindNextFileNameW function or closed with the FindClose function.

If the function fails, the return value is INVALID_HANDLE_VALUE (0xffffffff). To get extended error information, call the GetLastError function.

Remarks

In Windows 8 and Windows Server 2012, this function is supported by the following technologies.

Requirements

See also

File Management Functions

FindClose

FindFirstFileNameTransactedW

FindNextFileNameW