Previous Next

IoCreateSymbolicLink

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

NTSTATUS 
  IoCreateSymbolicLink(
    IN PUNICODE_STRING  SymbolicLinkName,
    IN 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.

Headers

Declared in wdm.h and ntddk.h. Include wdm.h or ntddk.h.

Comments

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 on when to use IoCreateSymbolicLink, see Named Device Objects.

Callers of IoCreateSymbolicLink must be running at IRQL = PASSIVE_LEVEL.

See Also

IoRegisterDeviceInterface, IoAssignArcName, IoCreateUnprotectedSymbolicLink, IoDeleteSymbolicLink