Share via

IOCTL_SERVICE_CONSOLE (Compact 2013)

  • Article

3/26/2014

This I/O control message turns a service's console on or off, depending on whether an "on" or "off" string is passed as an input parameter. Send this message with DeviceIoControl.

Syntax

BOOL DeviceIoControl(
    HANDLE hDevice,          // handle to the device
    DWORD dwIoControlCode,   // use IOCTL_SERVICE_CONSOLE
    LPVOID lpInBuffer,       // pointer to input buffer
    DWORD nInBufferSize,     // input buffer size
    LPVOID lpOutBuffer,      // pointer to output buffer
    DWORD nOutBufferSize,    // output buffer size
    LPDWORD lpBytesReturned, // number of bytes returned
    OVERLAPPED lpOverlapped  // pointer to OVERLAPPED structure
);

Parameters

  • hDevice
    [in] Handle to the device.
  • dwIoControlCode
    [in] The control code for the operation. Use IOCTL_SERVICE_CONSOLE for this operation.
  • lpInBuffer
    [in] String specifying the whether the console is to be turned on or off.

Return Values

Returns TRUE if successful; otherwise, returns FALSE. To obtain extended error information, call the SetLastError function.

Remarks

Consoles are interactive command prompts implemented by a service that enable an operator to obtain extended information about a service and/or configure the service in greater detail than is possible from the Services.exe command line options.

The options that the console supports will depend on the service. In Windows Embedded Compact, services are not required to implement consoles.

Requirements

Header

service.h

See Also

Reference

Servicesd.exe IOCTLS