Walk Method

Description

Sends one or more requests to retrieve the variable tree under the specified root OID.

Syntax

Visual Basic
Public Function Walk( _ ByVal rootOid As String, _ ByVal pdu As PduConstants, _ ByVal communityString As String, _ ByVal securityParams As Security, _ ByVal targetEP As IPEndPoint, _ ByVal localEP As IPEndPoint, _ Optional ByVal maximumRepetitions As Integer = 100, _ Optional ByVal timeout As Integer = 1000, _ Optional ByVal retries As Integer = 2, _ Optional ByVal threading As ThreadingConstants = threadingBlock, _ Optional ByVal userState As Variant _ ) As VariableList

Visual Basic

Public Function Walk( _
   ByVal rootOid As String, _
   ByVal pdu As PduConstants, _
   ByVal communityString As String, _
   ByVal securityParams As Security, _
   ByVal targetEP As IPEndPoint, _
   ByVal localEP As IPEndPoint, _
   Optional ByVal maximumRepetitions As Integer = 100, _
   Optional ByVal timeout As Integer = 1000, _
   Optional ByVal retries As Integer = 2, _
   Optional ByVal threading As ThreadingConstants = threadingBlock, _
   Optional ByVal userState As Variant _
) As VariableList

Parameters

rootOid

Any Object ID (OID) under which all Variables will be gathered and returned. Specify a table OID to retrieve all values in a table.

pdu

Value	Description
pdu1	Version 1 PDU (use as a mask).
pdu2	Version 2 PDU (use as a mask).
pdu3	Version 3 PDU (use as a mask).
pduGet	A GetRequest PDU (use as a mask).
pduGet1	Version 1 GetRequest PDU.
pduGet2	Version 2 GetRequest PDU.
pduGet3	Version 3 GetRequest PDU.
pduGetBulk	A GetBulkRequest PDU (use as a mask).
pduGetBulk2	Version 2 GetBulkRequest PDU.
pduGetBulk3	Version 3 GetBulkRequest PDU.
pduGetNext	A GetNextRequest PDU (use as a mask).
pduGetNext1	Version 1 GetNextRequest PDU.
pduGetNext2	Version 2 GetNextRequest PDU.
pduGetNext3	Version 3 GetNextRequest PDU.
pduInform	An InformRequest PDU (use as a mask).
pduInform2	Version 2 InformRequest PDU.
pduInform3	Version 3 InformRequest PDU.
pduReport	A Report PDU (use as a mask).
pduReport3	Version 3 ReportResponse PDU.
pduRequest	A GetRequest, GetNextRequest, SetRequest, InformRequest or GetBulkRequest PDU (use as a mask).
pduResponse	A GetResponse PDU (use as a mask).
pduResponse1	Version 1 GetResponse PDU.
pduResponse2	Version 2 GetResponse PDU.
pduResponse3	Version 3 GetResponse PDU.
pduSet	A SetRequest PDU (use as a mask).
pduSet1	Version 1 SetRequest PDU.
pduSet2	Version 2 SetRequest PDU.
pduSet3	Version 3 SetRequest PDU.
pduTrap	A Trap PDU (use as a mask).
pduTrap1	Version 1 Trap PDU.
pduTrap2	Version 2 Trap PDU.
pduTrap3	Version 3 Trap PDU.

Request type. Must be a GetNext or GetBulk type.

communityString

Specify for version 1 and 2 agents.

securityParams

Must be NULL/Nothing for version 1/2 agents. Must reference a Security object for version 3 agents.

targetEP

Target address.

localEP

The local network interface to bind to for the operation. Can be NULL/Nothing.

maximumRepetitions

Specifies the maximum number of variables to request when pdu specifies a GetBulkRequest type. Unused when pdu specifies a GetNextRequest type.

timeout

The length of time, in milliseconds, to wait for a response message before timing out or retrying.

retries

The number of retries that should be attempted before failing with a timeout error.

threading

Value	Description
threadingAsync	Implements Apartment Model threading without method blocking.
threadingBlock	Implements Apartment Model threading with method blocking (UI messages are processed).
threadingFree	Implements Free Model threading with method blocking (UI messages are not processed).

The threading model the control will use when executing this method.

userState

Object to pass to the WalkResponse event; can be NULL/Nothing.

Return Value

VariableList containing the requested variables.

Remarks

VariableList.ToTable can be used to format the list into a 2-dimensional table array.

When used asynchronously (threading is threadingAsync), the WalkResponse event will be raised with the requested variables when the operation completes.

pdu must be pduGetNext1, pduGetNext2, pduGetNext3, pduGetBulk2 or pduGetBulk3.

If localEP is specified, the socket is bound to the specified address family, address and port for the operation. If NULL/Nothing, a socket is created that uses a compatible 'Any' local interface and an ephemeral port.