RtkRtssAttach

RtkRtssAttach attaches a Windows 64 kernel device driver to the wRTOS real-time Subsystem.

Syntax

NTSTATUS RtkRtssAttach(
    [in]    ULONG MaxWFSO,
    [out]   PRTSSINST RtssInstPtr
);

Parameters

[in] MaxWFSO

The count of the number of wait-for-single-objects the user requires. The required minimum is one.

[out] RtssInstPtr

A pointer to an RTSSINST object that will return a non-zero value if the function succeeds and 0 if the function fails.

Return Value

If the function succeeds, it returns STATUS_SUCCESS. If the function fails, it returns one of the following NTSTATUS error codes:

• STATUS_UNSUCCESSFUL
• STATUS_INVALID_PARAMETER
• STATUS_LICENSE_VIOLATION

Remarks

This call should be made only once by a kernel-resident device driver. The returned instance must be used for all subsequent RTKAPI calls. This call is usually made at, but not restricted to, driver entry, unless your device driver is set to start at boot time.

If the device driver caller starts at boot time, you must:

1. Set the wRTOS Subsystem to start at the boot time.
2. Set your driver dependencies to depend on the wRTOS Subsystem (wRTOS_Rtss.sys). For information on setting dependencies, see the Microsoft article at https://learn.microsoft.com/en-us/windows-hardware/drivers/install/specifying-driver-load-order
3. Make this call only once in the Driver Dispatch routine and never in the DriverEntry routine.

Requirements

See Also:

• RtkRtssAttachEx
• RtkRtssDetach