_FILE_LINKS_INFORMATION structure

The FILE_LINKS_INFORMATION structure is used to query NTFS hard links to an existing file.

Syntax

typedef struct _FILE_LINKS_INFORMATION {
  ULONG                       BytesNeeded;
  ULONG                       EntriesReturned;
  FILE_LINK_ENTRY_INFORMATION Entry;
} *PFILE_LINKS_INFORMATION, FILE_LINKS_INFORMATION;

Members

BytesNeeded

The number of bytes needed to hold all available names returned using the Entry member. This value must be greater than 0.

EntriesReturned

The number of FILE_LINK_ENTRY_INFORMATION structures that have been returned using the Entry member.

Entry

A buffer that contains the returned FILE_LINK_ENTRY_INFORMATION structures.

Remarks

If the member EntriesReturned has a value of 0, there is not enough available memory to return an entry. The error STATUS_BUFFER_OVERFLOW (0x80000005) indicates that not all available entries were returned.

The member Entry is the first FILE_LINK_ENTRY_INFORMATION structure in a list of entries. Each entry is located sizeof(FILE_LINK_ENTRY_INFORMATION) + ((FileNameLength - 1 ) * sizeof(WCHAR)) from the previous entry when the FileNameLength member of FILE_LINK_ENTRY_INFORMATION > 1. Otherwise, each entry is located sizeof(FILE_LINK_ENTRY_INFORMATION) from the previous entry.

Requirements

   
Windows version Available starting with Windows Vista. Available starting with Windows Vista.
Header ntifs.h (include FltKernel.h, Ntifs.h)