---
title: setIdlePolicy
framework: hiddriverkit
role: symbol
role_heading: Instance Method
path: hiddriverkit/iouserusbhosthiddevice/setidlepolicy
---

# setIdlePolicy

Sets the amount of idle time that must pass before suspending the device.

## Declaration

```occ
virtual kern_return_t setIdlePolicy(USBIdlePolicyType type, uint16_t idleTimeMs);
```

## Parameters

- `type`: The target of the idle policy. For a list of possible values, see doc://com.apple.hiddriverkit/documentation/HIDDriverKit/USBIdlePolicyType.
- `idleTimeMs`: The idle time in milliseconds.

## Return Value

Return Value kIOReturnSuccess on success, or another value if an error occurs. See Error Codes.

## Discussion

Discussion Once the interface or pipe is idle, it defers electrical suspension of the device for the specified duration.

## See Also

### Configuring the Device

- [setProtocol](hiddriverkit/iouserusbhosthiddevice/setprotocol.md)
- [setIdle](hiddriverkit/iouserusbhosthiddevice/setidle.md)
- [setProperty](hiddriverkit/iouserusbhosthiddevice/setproperty.md)
- [reset](hiddriverkit/iouserusbhosthiddevice/reset.md)
- [USBIdlePolicyType](hiddriverkit/usbidlepolicytype.md)