ProSoft Technology MVI69-ADM User Manual

Page 148

Advertising
background image

Application Development Function Library - ADM API

MVI-ADM ♦ 'C' Programmable

Developer's Guide

'C' Programmable Application Development Module

Page 148 of 342

ProSoft Technology, Inc.

February 20, 2013

ADM_DBGetBuff

Syntax

char * ADM_DBGetBuff(ADMHANDLE adm_handle, unsigned short offset, const
unsigned short count, char * str)

Parameters

adm_handle

Handle returned by previous call to ADM_Open

offset

Character offset into database where the buffer starts

count

Number of characters to retrieve

str

String buffer to receive characters

Description
This function copies a buffer of characters in the database to a character buffer.

adm_handle must be a valid handle returned from ADM_Open.

Return Value

ADM_SUCCESS

No errors were encountered

ADM_ERR_NOACCESS

adm_handle does not have access

ADM_ERR_MEMORY

database is not allocated

ADM_ERR_REG_RANGE

offset is out of range

Example

ADMHANDLE adm_handle;
unsigned short offset;
const unsigned short char_count;
char *string_buff;
ADM_DBGetBuff(adm_handle, offset, char_count, string_buff);

See Also
ADM_DBSetBuff (page 149)

Advertising