Adm api functions – ProSoft Technology MVI69-ADM User Manual

Page 120

Advertising
background image

Application Development Function Library - ADM API

MVI-ADM ♦ 'C' Programmable

Developer's Guide

'C' Programmable Application Development Module

Page 120 of 342

ProSoft Technology, Inc.

February 20, 2013

7.1

ADM API Functions

This section provides detailed programming information for each of the ADM API
library functions. The calling convention for each API function is shown in 'C'
format.

The same set of API functions is supported for all of the modules in the MVI
family. Differences between modules are noted where appropriate.

API library routines are categorized according to functionality.

Function Category

Function Name

Description

Initialization

ADM_Open

Initialize access to the API

ADM_Close

Terminate access to the API

Debug Port

ADM_ProcessDebug

Debug port user interface

ADM_DAWriteSendCtl

Writes a data analyzer Tx control symbol

ADM_DAWriteRecvCtl

Writes a data analyzer Rx control symbol

ADM_DAWriteSendData

Writes a data analyzer Tx data byte

ADM_DAWriteRecvData

Writes a data analyzer Rx data byte

ADM_ConPrint

Outputs characters to Debug port

ADM_CheckDBPort

Checks for character input on Debug port

Database

ADM_DBOpen

Initializes database

ADM_DBClose

Closes database

ADM_DBZero

Zeros database

ADM_DBGetBit

Read a bit from the database

ADM_DBSetBit

Write a 1 to a bit to the database

ADM_DBClearBit

Write a 0 to a bit to the database

ADM_DBGetByte

Read a byte from the database

ADM_DBSetByte

Write a byte to the database

ADM_DBGetWord

Read a word from the database

ADM_DBSetWord

Write a word to the database

ADM_DBGetLong

Read a double word from the database

ADM_DBSetLong

Write a double word to the database

ADM_DBGetFloat

Read a floating-point number from the
database

ADM_DBSetFloat

Write a floating-point number to the database

ADM_DBGetDFloat

Read a double floating-point number from the
database

ADM_DBSetDFloat

Write a double floating-point number to the
database

ADM_DBGetBuff

Reads a character buffer from the database

ADM_DBSetBuff

Writes a character buffer to the database

ADM_DBGetRegs

Read multiple word registers from the
database

ADM_DBSetRegs

Write multiple word registers to the database

Advertising