ProSoft Technology MVI69-ADM User Manual

Page 172

Advertising
background image

Application Development Function Library - ADM API

MVI-ADM ♦ 'C' Programmable

Developer's Guide

'C' Programmable Application Development Module

Page 172 of 342

ProSoft Technology, Inc.

February 20, 2013

ADM_ReadBtCfg

Syntax

int ADM_ReadBtCfg(ADMHANDLE adm_handle, ADM_INTERFACE * adm_interface_ptr, int
verbose)

Parameters

adm_handle

Handle returned by previous call to ADM_Open

adm_interface_ptr

Pointer to ADM_INTERFACE structure to allow API access to
structures

verbose

Switch to enable status messages to the debug port. A 1 will
enable messages and a 0 will disable the messages.

Description
This function reads the module configuration from the processor. The function
will make a call to the function pointed to by

interface.process_cfg_ptr. T

he

user function can be used to perform boundary checking on the configuration
parameters.

MVI69 Note
This is a null function for the MVI69.

MVI94 Note
This function is a null function for the MVI94.

Return Value:

ADM_SUCCESS

No errors were encountered

ADM_ERR_NOACCESS

adm_handle does not have access, or configuration was
interrupted by operator.

ADM_ERR_NOTSUPPORTED

This function is not supported on this platform

Example

ADMHANDLE adm_handle;
ADM_INTERFACE *interface_ptr;
int verbose = 1;
ADM_INTERFACE interface;
interface_ptr = &interface;
ADM_ReadBtCfg(adm_handle, interface_ptr, verbose);

See Also
ADM_BtOpen (page 169)

Advertising