Función SnmpStrToOid (winsnmp.h)
[SNMP está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. En versiones posteriores podría modificarse o no estar disponible. En su lugar, use la administración remota de Windows, que es la implementación de Microsoft de WS-Man.]
La función SnmpStrToOid de WinSNMP convierte el formato de cadena numérica punteada de un identificador de objeto SNMP, por ejemplo, "1.2.3.4.5.6", en su representación binaria interna.
Sintaxis
SNMPAPI_STATUS SNMPAPI_CALL SnmpStrToOid(
[in] LPCSTR string,
[out] smiLPOID dstOID
);
Parámetros
[in] string
Puntero a una cadena de identificador de objeto terminada en null que se va a convertir.
[out] dstOID
Puntero a una estructura smiOID que recibe el valor convertido.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es el número de subidentificadores en el identificador de objeto convertido. Este número también es el valor del miembro len de la estructura smiOID a la que apunta el parámetro dstOID .
Si se produce un error en la función, el valor devuelto es SNMPAPI_FAILURE. Para obtener información de error extendida, llame a SnmpGetLastError especificando un valor NULL en su parámetro de sesión . La función SnmpGetLastError puede devolver uno de los siguientes errores.
| Código devuelto | Descripción |
|---|---|
|
La función SnmpStartup no se completó correctamente. |
|
Error durante la asignación de memoria. |
|
El parámetro string no es válido. Para obtener más información, vea la siguiente sección Comentarios. |
|
Error desconocido o indefinido. |
Comentarios
La aplicación WinSNMP debe llamar a la función SnmpFreeDescriptor para liberar recursos asignados para el miembro ptr de la estructura smiOID a la que apunta el parámetro dstOID . En la entrada, SnmpFreeDescriptor omite los miembros de esta estructura smiOID . La implementación de Microsoft WinSNMP sobrescribe los miembros smiOID si la función se completa correctamente.
Se produce un error en la función SnmpStrToOid y devuelve el código de error SNMPAPI_OID_INVALID si el parámetro de cadena cumple una de las condiciones siguientes:
- No está terminada en null.
- No es la forma textual de un identificador de objeto válido.
- Es insuficiente en longitud; todos los identificadores de objeto deben tener dos subidentificadores.
- Supera MAXOBJIDSTRSIZE de 1408 bytes.
Requisitos
| Cliente mínimo compatible | Windows 2000 Professional [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows 2000 Server [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | winsnmp.h |
| Library | Wsnmp32.lib |
| Archivo DLL | Wsnmp32.dll |