VARIABLE_RECORD

 

The VARIABLE_RECORD structure defines the association between program variables and MIB variables which will be used in IDA_GetVarsand IDA_SetVarsAPI calls.

typedef struct idaVarRecord_s {

idaVarID_t varID;

void *datap;

ulong dataLen;

ulong dataItemLen;

void *instancep;

ulong instanceLen;

ulong instanceItemLen;

ulong *instanceCountp;

ubyte varType;

ubyte unused;

ushort varResponseFlags;

 

} idaVarRecord_t;

 

Members

varID

IDA form of MIB variable object identifier. IDAApis.h has #defines for all possible values.

datap               

Pointer to buffer that holds variable data. For table variables, buffer might hold multiple instances (array elements) of the variable. For GETs, this will contain the result data. For Sets, this will point to data being SET.

dataLen

Length of buffer pointed to by datap.

dataItemLen  

Length in bytes for each instance of data. If only partial data is desired, this length can be set to a smaller than the maximum size possible.

instancep

Pointer to buffer that holds instance identifier data This field can be NULL in the following cases: if no instance data is provided for the request, if instance is implied zero for GETs/SETs of scaler variables, or if user doesn’t require return instance information on GET_NEXT/GET_BULK and user doesn’t need to provide start point instance information.

instanceLen  

Len of buffer pointed to by instancep.

instanceItemLen          

Length for each element of instance identifier data.

instanceCountp            

pointer to ulong variable where number of instances is specified (on request) or returned (upon completion).

varType

SNMP variable type. IDAApis.h has #defines for SNMP variable types such as SNMP_TYPE_Integer32. Variable type can also be an exception value such as SNMP_TYPE_endOfMibView.

varResponseFlags

Reports additional details and exception conditions for a variable. The following values are defined:

Attribute	Meaning
IDAVAR_EndOfView
IDAVAR_DataLostDataLen
IDAVAR_DataLostItemLen
IDAVAR_DataLostInstLen
IDAVAR_DataLostInstItemLen
IDAVAR_InstHasVarId	Turned on for repeat vars of a plain GET_BULK. Indicates that returned instance info starts with binary varID and then has the instance part of the SNMP object id.