Click or drag to resize

wclSerialClientGetModemStatus Method

Retrieves the modem control-register values.

Namespace: wclSerialFramework
Assembly: wclSerialFramework (in wclSerialFramework.dll) Version: 8.0.6.0
Syntax
Copy
public int GetModemStatus(
	out wclModemStatus Status
)

Parameters

Status  wclModemStatus
If the method completed with success the parameter contaisn the current state of the modem control-register values.

Return Value

Int32
If the method completed with success the return value is WCL_E_SUCCESS. Otherwise the method returns one of the WCL error codes.
Remarks

The GetModemStatus method is useful when you received the CTS, RLSD, DSR, or ring indicator signals (through the OnEvent event).

The method fails if the hardware does not support the control-register values.

See Also