SnmpMgrStrToOid

The SnmpMgrStrToOid function converts the string format of an object identifier to its internal object identifier structure. This function is an element of the SNMP Management API.

BOOL SnmpMgrStrToOid(
  LPSTR string,             // string to convert
  AsnObjectIdentifier *oid  // object identifier representation
);

Parameters

string

[in] Pointer to a null-terminated string to convert.

oid

[out] Pointer to an object identifier variable to receive the converted value.

Return Values

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. This function does not return Windows Sockets error codes.

Remarks

If an application passes a valid object identifier to SnmpMgrStrToOid, yet is unable to obtain the requested variable, then the syntax of the system group and object identifier is incorrect. This occurs because SnmpMgrStrToOid assumes that the object identifier is under the Internet MIB of the management subtree.

You must always precede the object identifier with a period (.) to obtain the correct system group (for example, ".1.3.6.1.2.1.1"). If an application passes the variable "1.3.6.1.2.1.1", SnmpMgrStrToOid cannot interpret the object identifier correctly.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Unsupported.
  Header: Declared in Mgmtapi.h.
  Library: Use Mgmtapi.lib.

See Also

Simple Network Management Protocol (SNMP) Overview, SNMP Functions, SnmpMgrOidToStr