MicroGate API Reference

• Overview

  • Introduction
  • API Features
  • Adapter Features
  • API Function Overview
  
  

• Software Components

  • Software Components
  • Run Time Kit
  • Software Development Kit
  • Installation
  • Development Requirements
  
  

• API Description

  • API Description
  • Opening the Port
  • Configuring the Port
  • Asynchronous API Notification
  • Controlling and Monitoring Serial Signals
  • Sending Data
  • Sending Buffered Data
  • Receiving Data
  • General Purpose I/O
  • Closing the Port
  • Tracing
  • DPLL Clock Recovery
  • HDLC Mode
  • Raw, Bisync, Monosync Modes
  
  

• API Function Reference

  • API Function Reference
  • MgslCancelGetTraceEvent
  • MgslCancelWaitGpio
  • MgslCancelReceive
  • MgslCancelTransmit
  • MgslCancelWaitEvent
  • MgslClose
  • MgslEnableReceiver
  • MgslEnableTransmitter
  • MgslEnumeratePorts
  • MgslGetAssignedResources
  • MgslGetGpio
  • MgslGetOption
  • MgslGetParams
  • MgslGetPortConfig
  • MgslGetPortConfigEx
  • MgslGetSerialSignals
  • MgslGetTraceEvent
  • MgslGetTraceLevel
  • MgslOpen
  • MgslOpenDiagnostics
  • MgslOpenTraceHandle
  • MgslPutTraceEvent
  • MgslReceive
  • MgslResetTraceBuffers
  • MgslSetIdleMode
  • MgslSetGpio
  • MgslSetOption
  • MgslSetParams
  • MgslSetPortConfig
  • MgslSetPortConfigEx
  • MgslSetSerialSignals
  • MgslSetTraceLevel
  • MgslTransmit
  • MgslWaitEvent
  • MgslWaitGpio
  
  

• API Structures and Constants

  • API Structures and Constants
  • Diagnostics Status Constants
  • GPIO_DESC
  • HDLC_MAX_FRAME_SIZE Constant
  • MAX_ASYNC_TRANSMIT Constant
  • MGSL_ASSIGNED_RESOURCES Structure
  • MgslEvent Constants
  • MGSL_PCI_ADAPTER Structure
  • MGSL_PCI_ADAPTER_EX Structure
  • MGSL_TRACE_EVENT Structure
  • MGSL_PARAMS Structure
  • MGSL_PORT Structure
  • MGSL_PORT_CONFIG Structure
  • MGSL_PORT_CONFIG_EX Structure
  • MGSL_RECEIVE_REQUEST Structure
  • Serial Signal Constants
  • Transmit Status Constants
  
  

• Trace Reference

  • Trace Reference
  • Trace Levels
  • Trace Events
  • Transmit Events
  • Receive Events
  • Status Events
  • API Events
  • Data Events
  
  

• Driver Interface API

  • Overview
  • Building the Client Driver
  • Driver Load Order
  
  

• Driver Interface Functions

  • Overview
  • DiMgslCancelTransmit
  • DiMgslClose
  • DiMgslEnableReceiver
  • DiMgslEnableTransmitter
  • DiMgslGetOption
  • DiMgslGetParams
  • DiMgslGetSerialSignals
  • DiMgslGetTraceEvent
  • DiMgslGetTraceLevel
  • DiMgslMonitorEvents
  • DiMgslOpen
  • DiMgslPutTraceEvent
  • DiMgslReceive
  • DiMgslResetTraceBuffers
  • DiMgslSetIdleMode
  • DiMgslSetOption
  • DiMgslSetParams
  • DiMgslSetSerialSignals
  • DiMgslSetTraceLevel
  • DiMgslTransmit
  
  

• Driver Interface Callbacks

  • Overview
  • EventReady
  • ReceiveReady
  • TraceReady
  • TransmitComplete