ADM-XRC SDK 2.8.1 User Guide (Linux)
© Copyright 2001-2009 Alpha Data
Prototype
ADMXRC_STATUS ADMXRC_ReadReg( ADMXRC_HANDLE Card, unsigned char Index, unsigned char* Value);
Arguments
Argument | Type | Purpose |
Card | In | Handle of card on which the read is to take place |
Index | In | Index of control register to read |
Value | Out | Byte read from control register |
Return value
Value | Meaning |
ADMXRC_SUCCESS | The data was read successfully |
ADMXRC_INVALID_HANDLE | Card is not a valid card handle |
ADMXRC_INVALID_PARAMETER | Index was out of range. |
Description
The ADMXRC_ReadReg function reads the byte-wide control registers on an ADM-XRC or ADM-XRC-P card.
The Index parameter specifies the index of the register to read. Please refer to the user manual for your card for a map of the control registers.
The Value parameter must point to the variable that is to receive the value read from the specified register.