IoCreateSymbolicLink function

The IoCreateSymbolicLink routine sets up a symbolic link between a device object name and a user-visible name for the device.

Syntax

NTKERNELAPI NTSTATUS IoCreateSymbolicLink(
  PUNICODE_STRING SymbolicLinkName,
  PUNICODE_STRING DeviceName
);

Parameters

SymbolicLinkName

Pointer to a buffered Unicode string that is the user-visible name.

DeviceName

Pointer to a buffered Unicode string that is the name of the driver-created device object.

Return Value

IoCreateSymbolicLink returns STATUS_SUCCESS if the symbolic link object was created.

Remarks

WDM drivers do not name device objects and therefore should not use this routine. Instead, a WDM driver should call IoRegisterDeviceInterface to set up a symbolic link.

For more information about when to use IoCreateSymbolicLink, see Named Device Objects.

Requirements

   
Windows version Available starting with Windows 2000.
Target Platform Universal
Header wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe
IRQL PASSIVE_LEVEL
DDI compliance rules IrqlIoPassive3, PowerIrpDDis, HwStorPortProhibitedDDIs

See Also

IoAssignArcName

IoCreateUnprotectedSymbolicLink

IoDeleteSymbolicLink

IoRegisterDeviceInterface