[This function may be altered or unavailable in the future.]
Retrieves information about the specified directory object.
Syntax
NTSTATUS WINAPI NtQueryDirectoryObject(
_In_ HANDLE DirectoryHandle,
_Out_opt_ PVOID Buffer,
_In_ ULONG Length,
_In_ BOOLEAN ReturnSingleEntry,
_In_ BOOLEAN RestartScan,
_Inout_ PULONG Context,
_Out_opt_ PULONG ReturnLength
);
Parameters
DirectoryHandle [in]
A handle to the directory object.
Buffer [out, optional]
A pointer to a buffer that receives the directory information. This buffer receives one or more OBJECT_DIRECTORY_INFORMATION structures, the last one being NULL, followed by strings that contain the names of the directory entries. For more information, see Remarks.
Length [in]
The size of the user-supplied output buffer, in bytes.
ReturnSingleEntry [in]
Indicates whether the function should return only a single entry.
RestartScan [in]
Indicates whether to restart the scan or continue the enumeration using the information passed in the Context parameter.
Context [in, out]
The enumeration context.
ReturnLength [out, optional]
A pointer to a variable that receives the length of the directory information returned in the output buffer, in bytes.
Return value
The function returns STATUS_SUCCESS or an error status.
Remarks
The following is the definition of the OBJECT_DIRECTORY_INFORMATION structure.
typedef struct _OBJECT_DIRECTORY_INFORMATION {
UNICODE_STRING Name;
UNICODE_STRING TypeName;
} OBJECT_DIRECTORY_INFORMATION, *POBJECT_DIRECTORY_INFORMATION;
This function has no associated import library or header file; you must call it using the LoadLibrary and GetProcAddress functions.
Requirements
| Requirement | Value |
|---|---|
| DLL | Ntdll.dll |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
