winsnmp.h header

This header is used by Simple Network Management Protocol. For more information, see:

• Simple Network Management Protocol

winsnmp.h contains the following programming interfaces:

Functions

SnmpCancelMsg A WinSNMP application calls the SnmpCancelMsg function to request that the Microsoft WinSNMP implementation cancel retransmission attempts and time-out notifications for an SNMP request message.
SnmpCleanup The SnmpCleanup function informs the Microsoft WinSNMP implementation that the calling WinSNMP application no longer requires the implementation's services.
SnmpCleanupEx The SnmpCleanupEx function performs cleanup when there are no outstanding successful calls to SnmpStartup or SnmpStartupEx within a Windows SNMP (WinSNMP) application.
SnmpClose The SnmpClose function enables the Microsoft WinSNMP implementation to deallocate memory, resources, and data structures associated with a WinSNMP session.
SnmpContextToStr The WinSNMP SnmpContextToStr function returns a string that identifies an SNMP context, which is a set of managed object resources. The function returns the string in an smiOCTETS structure.
SnmpCountVbl A WinSNMP application calls the WinSNMP SnmpCountVbl function to enumerate the variable binding entries in the specified variable bindings list.
SnmpCreatePdu The WinSNMP SnmpCreatePdu function creates and initializes an SNMP protocol data unit (PDU).
SnmpCreateSession The SnmpCreateSession function requests the Microsoft WinSNMP implementation to open a session for the WinSNMP application.
SnmpCreateVbl The WinSNMP SnmpCreateVbl function creates a new variable bindings list for the calling WinSNMP application.
SnmpDecodeMsg The WinSNMP SnmpDecodeMsg function decodes an encoded SNMP message into its components. This function performs the opposite action of the WinSNMP SnmpEncodeMsg function.
SnmpDeleteVb The WinSNMP SnmpDeleteVb function removes a variable binding entry from a variable bindings list.
SnmpDuplicatePdu The WinSNMP SnmpDuplicatePdu function duplicates the SNMP protocol data unit (PDU) that the PDU parameter identifies, allocating any necessary memory for the duplicate PDU.
SnmpDuplicateVbl The WinSNMP SnmpDuplicateVbl function copies a variable bindings list for the specified WinSNMP session. This function returns a handle to the copied variable bindings list and allocates any necessary memory for it.
SnmpEncodeMsg The Microsoft WinSNMP implementation uses the parameters passed in the WinSNMP SnmpEncodeMsg function to encode an SNMP message.
SnmpEntityToStr The WinSNMP SnmpEntityToStr function returns a string that identifies an SNMP management entity.
SnmpFreeContext The WinSNMP SnmpFreeContext function releases resources associated with an SNMP context, which is a set of managed object resources.
SnmpFreeDescriptor A WinSNMP application uses the SnmpFreeDescriptor function to inform the Microsoft WinSNMP implementation that it no longer requires access to a descriptor object.
SnmpFreeEntity The WinSNMP SnmpFreeEntity function releases resources associated with an SNMP management entity.
SnmpFreePdu The WinSNMP SnmpFreePdu function releases resources associated with an SNMP protocol data unit (PDU) created by the SnmpCreatePdu or the SnmpDuplicatePdu function.
SnmpFreeVbl The WinSNMP SnmpFreeVbl function releases resources associated with a variable bindings list. These are resources allocated previously by a call to the SnmpCreateVbl function or the SnmpDuplicateVbl function in a WinSNMP application.
SnmpGetLastError The WinSNMP SnmpGetLastError function returns the calling application's last-error code value. The value indicates the reason why the last function call executed by the WinSNMP application failed.
SnmpGetPduData The WinSNMP SnmpGetPduData function returns selected data fields from a specified SNMP protocol data unit (PDU).
SnmpGetRetransmitMode The WinSNMP SnmpGetRetransmitMode function returns the current setting of the retransmission mode to a WinSNMP application.
SnmpGetRetry The WinSNMP SnmpGetRetry function returns the retry count value, in units, for the retransmission of SNMP message requests. The retry count applies to calls that a WinSNMP application makes to the SnmpSendMsg function for a specified management entity.
SnmpGetTimeout The WinSNMP SnmpGetTimeout function returns the time-out value, in hundredths of a second, for the transmission of SNMP message requests.
SnmpGetTranslateMode The WinSNMP SnmpGetTranslateMode function returns the current setting of the entity and context translation mode to a WinSNMP application.
SnmpGetVb A WinSNMP application calls the SnmpGetVb function to retrieve information from a variable bindings list. This WinSNMP function retrieves a variable name and its associated value from the variable binding entry specified by the index parameter.
SnmpGetVendorInfo A WinSNMP application calls the SnmpGetVendorInfo function to retrieve information about the Microsoft WinSNMP implementation.
SnmpListen The WinSNMP SnmpListen function registers a WinSNMP application as an SNMP agent.
SnmpOidCompare The WinSNMP SnmpOidCompare function lexicographically compares two SNMP object identifiers, up to the length specified by the maxlen parameter.
SnmpOidCopy The WinSNMP SnmpOidCopy function copies an SNMP object identifier, allocating any necessary memory for the copy.
SnmpOidToStr The WinSNMP SnmpOidToStr function converts the internal binary representation of an SNMP object identifier to its dotted numeric string format, for example, to "1.2.3.4.5.6".
SnmpOpen The SnmpOpen function requests the Microsoft WinSNMP implementation to open a session for the WinSNMP application.
SnmpRecvMsg The WinSNMP SnmpRecvMsg function retrieves the results of a completed asynchronous request submitted by a call to the SnmpSendMsg function, in the form of an SNMP message.
SnmpRegister The WinSNMP SnmpRegister function registers or unregisters a WinSNMP application for trap and notification reception. The application can register and receive traps and notifications, or unregister and disable traps and notifications.
SnmpSendMsg A WinSNMP application calls the SnmpSendMsg function to request that the Microsoft WinSNMP implementation transmit an SNMP protocol data unit (PDU), in the form of an SNMP message.
SnmpSetPduData The WinSNMP SnmpSetPduData function updates selected data fields in the specified SNMP protocol data unit (PDU).
SnmpSetPort A WinSNMP application calls the SnmpSetPort function to change the port assigned to a destination entity. The SnmpSetPort function is an element of the WinSNMP API, version 2.0.
SnmpSetRetransmitMode The WinSNMP SnmpSetRetransmitMode function enables a WinSNMP application to set the retransmission mode.
SnmpSetRetry The WinSNMP SnmpSetRetry function enables a WinSNMP application to change the retry count value for the retransmission of SNMP message requests.
SnmpSetTimeout The WinSNMP SnmpSetTimeout function enables a WinSNMP application to change the time-out value for the transmission of SNMP message requests.
SnmpSetTranslateMode The WinSNMP SnmpSetTranslateMode function enables a WinSNMP application to change the entity and context translation mode. The entity and context translation mode affects the interpretation and return of WinSNMP input and output string parameters.
SnmpSetVb The WinSNMP SnmpSetVb function changes variable binding entries in a variable bindings list. This function also appends new variable binding entries to an existing variable bindings list.
SnmpStartup The SnmpStartup function notifies the Microsoft WinSNMP implementation that the WinSNMP application requires the implementation's services.
SnmpStartupEx The SnmpStartupEx function notifies the Microsoft WinSNMP implementation that the WinSNMP application requires the implementation's services.
SnmpStrToContext The WinSNMP SnmpStrToContext function returns a handle to SNMP context information that is specific to the Microsoft WinSNMP implementation.
SnmpStrToEntity The WinSNMP SnmpStrToEntity function returns a handle to information about an SNMP management entity that is specific to the Microsoft WinSNMP implementation.
SnmpStrToOid The WinSNMP SnmpStrToOid function converts the dotted numeric string format of an SNMP object identifier, for example, "1.2.3.4.5.6", to its internal binary representation.

Callback functions

SNMPAPI_CALLBACK The Microsoft WinSNMP implementation calls the SNMPAPI_CALLBACK function to notify a WinSNMP session that an SNMP message or asynchronous event is available.

Structures

smiCNTR64 The WinSNMP smiCNTR64 structure contains a 64-bit unsigned integer value. The structure represents a 64-bit counter.
smiOCTETS The WinSNMP smiOCTETS structure passes context strings to multiple WinSNMP functions. The structure also describes and receives encoded SNMP messages.
smiOID The WinSNMP smiOID structure passes object identifiers to multiple WinSNMP functions. The structure also receives the variable name of a variable binding entry in a call to the SnmpGetVb function.
smiVALUE The WinSNMP smiVALUE structure describes the value associated with a variable name in a variable binding entry.
smiVENDORINFO The smiVENDORINFO structure contains information about the Microsoft WinSNMP implementation.