API Function Overview

The application communicates with the API using the API functions. Below is a list of the functions by category.

Device Access


ULONG MgslOpen( ULONG PortID, HANDLE* pHandle );
ULONG MgslClose( HANDLE hDevice );

Device Configuration


ULONG MgslSetParams( HANDLE hDevice, PMGSL_PARAMS pParams );
ULONG MgslGetParams( HANDLE hDevice, PMGSL_PARAMS pParams );
ULONG MgslSetPortConfigEx( ULONG PortID, PMGSL_PORT_CONFIG_EX pConfig );
ULONG MgslGetPortConfigEx( ULONG PortID, PMGSL_PORT_CONFIG_EX pConfig );
ULONG MgslEnumeratePorts( PMGSL_PORT pPorts, ULONG BufferSize, PULONG PortCount );
ULONG MgslGetAssignedResources( HANDLE hDevice, PMGSL_ASSIGNED_RESOURCES pResources );
ULONG MgslSetOption( HANDLE hDevice, UINT option_id, UINT value );
ULONG MgslGetOption( HANDLE hDevice, UINT option_id, UINT *value );

Device Control and Status


ULONG MgslSetSerialSignals( HANDLE hDevice, UCHAR NewSignals );
ULONG MgslGetSerialSignals( HANDLE hDevice, PUCHAR pReturnedSignals );
ULONG MgslWaitEvent( HANDLE hDevice, ULONG EventMask, PULONG pEvents, LPOVERLAPPED pOverlapped );
ULONG MgslCancelWaitEvent( HANDLE hDevice );

Data Communications


ULONG MgslTransmit( HANDLE hDevice, PUCHAR pBuffer, ULONG BufferSize,  PULONG pStatus, LPOVERLAPPED pOverlapped );
ULONG MgslCancelTransmit( HANDLE hDevice );
ULONG MgslEnableTransmitter( HANDLE hDevice, BOOL EnableFlag );
ULONG MgslSetIdleMode( HANDLE hDevice, ULONG IdleMode );
ULONG MgslReceive( HANDLE hDevice, PMGSL_RECEIVE_REQUEST pRcvReq, LPOVERLAPPED pOverlapped );
ULONG MgslCancelReceive( HANDLE hDevice );
ULONG MgslEnableReceiver( HANDLE hDevice, BOOL EnableFlag );

Tracing

ULONG MgslResetTraceBuffers( HANDLE hDevice );
ULONG MgslGetTraceLevel( HANDLE hDevice, PULONG pTraceLevel );
ULONG MgslSetTraceLevel( HANDLE hDevice, ULONG NewTraceLevel );
ULONG MgslGetTraceEvent( HANDLE hDevice, PMGSL_TRACE_EVENT pTraceEvent, LPOVERLAPPED pOverlapped );
ULONG MgslCancelGetTraceEvent( HANDLE hDevice );
ULONG MgslPutTraceEvent( HANDLE hDevice, PMGSL_TRACE_EVENT pTraceEvent );

General Purpose I/O

ULONG  MgslSetGpio( HANDLE hDevice, GPIO_DESC *gpio );
ULONG  MgslGetGpio( HANDLE hDevice, GPIO_DESC *gpio );
ULONG  MgslWaitGpio( HANDLE hDevice, GPIO_DESC *gpio, LPOVERLAPPED ol );
ULONG  MgslCancelWaitGpio( HANDLE hDevice );

Contents