FindFirstFileNameTransactedW function (winbase.h)

[Microsoft strongly recommends developers utilize alternative means to achieve your application’s needs. Many scenarios that TxF was developed for can be achieved through simpler and more readily available techniques. Furthermore, TxF may not be available in future versions of Microsoft Windows. For more information, and alternatives to TxF, please see Alternatives to using Transactional NTFS.]

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

Syntax

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

Parameters

[in] lpFileName

The name of the file.

The file must reside on the local computer; otherwise, the function fails and the last error code is set to ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE (6805).

[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 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.

[in, optional] hTransaction

A handle to the transaction. This handle is returned by the CreateTransaction function.

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.

SMB 3.0 does not support TxF.

Requirements

See also

File Management Functions

FindClose

FindNextFileNameW

Transactional NTFS