ZwQuerySymbolicLinkObject routine

The ZwQuerySymbolicLinkObject routine returns a Unicode string that contains the target of a symbolic link.

Syntax

NTSTATUS ZwQuerySymbolicLinkObject(
  _In_       HANDLE LinkHandle,
  _Inout_    PUNICODE_STRING LinkTarget,
  _Out_opt_  PULONG ReturnedLength
);

Parameters

LinkHandle [in]

Handle to the symbolic-link object that you want to query. This handle is created by a successful call to ZwOpenSymbolicLinkObject.

LinkTarget [in, out]

Pointer to an initialized Unicode string that receives the target of the symbolic link.

ReturnedLength [out, optional]

contains the maximum number of bytes to copy into the Unicode string at LinkTarget. On output, the unsigned long integer contains the length of the Unicode string naming the target of the symbolic link.

Return value

ZwQuerySymbolicLinkObject returns either STATUS_SUCCESS to indicate the routine completed without error or STATUS_BUFFER_TOO_SMALL if the Unicode string provided at LinkTarget is too small to hold the returned string.

Remarks

Before calling this routine, driver writers must ensure that the Unicode string at LinkTarget has been properly initialized and a buffer for the string has been allocated. The MaximumLength and Buffer members of the Unicode string must be set before calling ZwQuerySymbolicLinkObject or the call will fail.

If ZwQuerySymbolicLinkObject returns STATUS_BUFFER_TOO_SMALL drivers should examine the value returned at ReturnedLength. The number returned in this variable indicates the maximum length that the Unicode string for the target of the symbolic link.

Note  If the call to this function occurs in user mode, you should use the name "NtQuerySymbolicLinkObject" instead of "ZwQuerySymbolicLinkObject".

Requirements

See also

ZwOpenSymbolicLinkObject

Send comments about this topic to Microsoft

Build date: 5/22/2013