Funções de PDU

---

Aqui são apresentadas as funções que constrõem as PDUs usadas nas chamadas às funções SnmpSendMsg e SnmpEncodeMsg, e que decompõem através das funções SnmpRecvMsg e SnmpDecodeMsg.

---

SnmpCreatePdu()

Descrição:

A função aloca e inicializa uma unidade de dados do protocolo SNMP para as subsequentes chamada à SnmpSendMsg, SnmpEncodeMsg e outras funções.

Note que todo parâmetro de entrado para SnmpCreatePdu deve esta presente mas, com excessão do parâmetro de sessão, todos podem ter valor NULL, resultando numa PDU default como descrito abaixo.

Sintaxe:

HSNMP_PDU SnmpCreatePdu ( IN HSNMP_SESSION session, IN smiINT PDU_type, IN smiINT32 request_id, IN smiINT error_status, -- "non_repeaters" for BulkPDU IN smiINT error_index, -- "max_repetitions" for BulkPDU IN HSNMP_VBL vbl;

Parâmetros:

• session - Handle da sessão;
• PDU_type - NULL ou um dos possíveis valor para PDU_types;
• request_id - Um valor fornecido pela aplicação para identificar a PDU, ou NULL no caso em que a implementação WinSNMP fornecerá seu próprio valor;
• error_status - Ignorado (e deve ser NULL) na entrada para todos os tipos de PDU, exceto para SNMP_PDU_GETBULK;
• error_index - Ignorado (e deve ser NULL) na entrada para todos os tipos de PDU, exceto para SNMP_PDU_GETBULK
• vbl - Um handle para uma estrutura varbindlis ou então NULL.

Retorno:

Se função for executada sem error o valor de retorno identificará a unidade de dados do protocolo SNMP criada. Se a função falhar o retorno será SNMPAPI_FAILURE. Informações adicionais sobre o erro ocorrido são conseguidas através de SnmpGetLastError.

Comentários:

Informando valores NULL para todos os parâmetros de entrada (exceto session) a unidade de dados do protocolo criada possui os seguintes valores default:

• PDU_type: SNMP_PDU_GETNEXT
• request_id: <Valor gerado pela implementação WinSNMP>
• error_status: SNMP_ERROR_NOERROR
• error_index: 0
• vbl: NULL

Após completar as operações com a PDU criada, a função SnmpFreePdu deve ser chamada para liberar os recursos associados.

---

SnmpGetPduData()

Descrição:

A função extrai elementos de dados selecionados de uma PDU específica e copia os mesmo para as estruturas passadas como parâmetros.

Sintaxe:

SNMPAPI_STATUS SnmpGetPduData ( IN HSNMP_PDU PDU, OUT smiLPINT PDU_type, OUT smiLPINT32 request_id, OUT smiLPINT error_status, -- "non_repeaters" for GetBulkRequest-PDU OUT smiLPINT error_index, -- "max_repetitions" for GetBulkRequest-PDU OUT LPHSNMP_VBL vbl);

Parâmetros:

• PDU - Identifica a PDU;
• PDU_type - Se não for NULL aponta para uma variável snmiINT que receberá o valor PDU_type da PDU especificada;
• request_id - Se não for NULL aponta para uma variável smiINT32 que receberá o valor do request_id da PDU especificada;
• error_status - Se não for NULL aponta para uma variável smiINT que receberá o error_status da PDU especificada;
• error_index - Se nào for NULL aponta para uma variável smiINT que receberá o error_index da PDU especificada;
• vbl - Se não for NULL aponta para uma variável HSNMP_VBL que receberá o handle da varbindlist da PDU especificada.

Retorno:

Se a função for executada com sucesso o retorno será SNMPAPI_SUCCES.Em caso de falha o retorno será SNMPAPI_FAILURE.

---

SnmpSetPduData()

Descrição:

A função atualiza elementos selecionados de uma PDU.

Sintaxe:

SNMPAPI_STATUS SnmpSetPduData ( IN HSNMP_PDU PDU, IN smiLPINT PDU_type, IN smiLPINT32 request_id, IN smiLPINT non_repeaters, -- for GetBulkRequest-PDU only IN smiLPINT max_repetitions, -- for GetBulkRequest-PDU only IN LPHSNMP_VBL vbl);

Parâmetros:

• PDU - Identifica a PDU;
• PDU_type - Se diferente de NULL aponta para uma variável smiINT que atualizará o elemento PDU_type;
• request_id - Se diferente de NULL, aponta para uma variável smiINT32 que atualizará o elemtno request_id;
• non_repeaters - Se diferente de NULL, aponta para uma variável smiINT que atualizará o elemento non_repeater do GetBulkRequest-PDU (ignorado para outros tipos de PDU);
• max_repetitions - Se diferente de NULL, aponta para uma variável smiINT que atualizará o elemento max_repetition da PDU GetBulkRequest-PDU (ignorado para outros tipos de PDU);
• vbl - Se diferente de NULL, aponta para uma variável HSNMP_VBL que atualizará o handle da varbindlist da PDU.

Retorno:

Se a função terminou com sucesso o retorno será SNMPAPI_SUCCESS. Caso contrário teremos SNMPAPI_FAILURE.

---

SnmpDuplicatePdu()

Descrição:

A função duplica uma PDU especificada.

Sintaxe:

HSNMP_PDU SnmpDuplicatePdu ( IN HSNMP_SESSION session, IN HSNMP_PDU PDU);

Parâmetros:

• session - Handle da sessão;
• PDU - Identificador da PDU as ser duplicada.

Retorno:

Se a função terminou com sucesso o retorno será SNMPAPI_SUCCESS. Caso contrário teremos SNMPAPI_FAILURE.

---

SnmpFreePdu()

Descrição:

A função libera os recursos associados à PDU especificada.

Sintaxe:

SNMPAPI_STATUS SnmpFreePdu ( IN HSNMP_PDU PDU);

Parâmetros:

• PDU - Identificador da PDU a ser liberada.

Retorno:

Se a função terminou com sucesso o retorno será SNMPAPI_SUCCESS. Caso contrário teremos SNMPAPI_FAILURE.