IOCTL_SERIAL_GET_PROPERTIES (Compact 2013)
3/26/2014
This I/O control message retrieves information about the communications properties for a device. Send this message with DeviceIoControl.
Syntax
BOOL DeviceIoControl(
HANDLE hDevice, // handle to the device
DWORD dwIoControlCode, // use IOCTL_SERIAL_GET_PROPERTIES
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. To obtain a device handle, call COM_Open.
- dwIoControlCode
[in] Control code for the operation. Use IOCTL_SERIAL_GET_PROPERTIES for this operation.
- lpInBuffer
Ignored.
- nInBufferSize
Ignored.
- lpOutBuffer
[out] Pointer to a COMMPROP structure.
- nOutBufferSize
[out] Greater than or equal to sizeof(COMMPROP).
- lpBytesReturned
[out] Pointer to a DWORD variable to return length of returned data. If there is no error, set to sizeof(COMMPROP).
- lpOverlapped
Ignored.
Return Values
Returns TRUE if successful; otherwise, returns FALSE.
Remarks
To get extended error information, call GetLastError. GetLastError may return other standard error messages as appropriate.
Requirements
Header |
pegdser.h |
See Also
Reference
Serial Port Driver IOCTLs
COM_Open
DeviceIoControl