IOCTL_POINT_OF_SERVICE_RETAIN_DEVICE IOCTL (pointofservicedriverinterface.h)

  • Article

This I/O control function is used to keep a claim on a device when a client is notified that its claim on the device is being contested by another client.

Major code

IRP_MJ_DEVICE_CONTROL

Input buffer

Not used with this operation; set to NULL.

Input buffer length

Not used with this operation; set to 0 (zero).

Output buffer

Not used with this operation; set to NULL.

Output buffer length

Not used with this operation; set to 0 (zero)

Status block

Returns TRUE if successful; otherwise, returns FALSE.

Remarks

To get extended error information, call GetLastError. The following list shows common error values:

  • STATUS_ACCESS_DENIED: The device is currently claimed by another client.

  • STATUS_DEVICE_NOT_READY: The POS library has not successfully initialized.

This IOCTL only works if the client has previously called IOCTL_POINT_OF_SERVICE_CLAIM_DEVICE.

When handling this IOCTL, the driver can call PosCxRetainDevice. The driver writer does not need to handle claim contention because the PosCx library determines who gets the claim.

Requirements

Requirement Value
Header pointofservicedriverinterface.h (include Pointofservicedriverinterface.h)