C
BOOL SNMPGetVar( SNMP_ID var, SNMP_INDEX index, BYTE* ref, SNMP_VAL* val );
Description
This is a callback function called by SNMP module. SNMP user must implement this function in user application and provide appropriate data when called.
Preconditions
None
Parameters
|
Parameters |
Description |
|
var |
Variable id whose value is to be returned |
|
index |
Index of variable that should be transferred |
|
ref |
Variable reference used to transfer multi-byte data It is always SNMP_START_OF_VAR when very first byte is requested. Otherwise, use this as a reference to keep track of multi-byte transfers. |
|
val |
Pointer to up to 4 byte buffer. If var data type is BYTE, transfer data in val->byte If var data type is WORD, transfer data in val->word If var data type is DWORD, transfer data in val->dword If var data type is IP_ADDRESS, transfer data in val->v[] or val->dword If var data type is COUNTER32, TIME_TICKS or GAUGE32, transfer data in val->dword If var data type is ASCII_STRING or OCTET_STRING transfer data in val->byte using multi-byte transfer mechanism. |
Return Values
|
Return Values |
Description |
|
TRUE |
If a value exists for given variable at given index. |
|
FALSE |
Otherwise. |
Remarks
None.