Función SnmpContextToStr (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 SnmpContextToStr de WinSNMP devuelve una cadena que identifica un contexto SNMP, que es un conjunto de recursos de objeto administrado. La función devuelve la cadena en una estructura smiOCTETS .
Sintaxis
SNMPAPI_STATUS SNMPAPI_CALL SnmpContextToStr(
[in] HSNMP_CONTEXT context,
[out] smiLPOCTETS string
);
Parámetros
[in] context
Controle el contexto snmp de interés.
[out] string
Puntero a una estructura smiOCTETS para recibir la cadena que identifica el contexto de interés. La cadena puede tener un byte de terminación NULL.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es SNMPAPI_SUCCESS.
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. 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 de contexto no es válido. |
|
Error desconocido o indefinido. |
Comentarios
La configuración actual del modo de traducción de entidad y contexto determina el tipo de cadena de salida SnmpContextToStr devuelve. Para obtener más información, vea Establecer el modo de conversión de entidad y contexto.
La aplicación WinSNMP debe proporcionar la dirección de una estructura smiOCTETS válida para el parámetro string . Si la función SnmpContextToStr se completa correctamente, la implementación de Microsoft WinSNMP inicializa los miembros len y ptr de la estructura. La aplicación WinSNMP debe llamar a la función SnmpFreeDescriptor para permitir que la implementación libere los recursos para estos miembros.
Cuando la entidad y el modo de traducción de contexto se SNMPAPI_TRANSLATED y la entrada existe en la base de datos de la implementación, la implementación devuelve el nombre descriptivo asociado del contexto. Si no existe una entrada para el nombre de contexto, SnmpContextToStr devuelve la cadena de la comunidad SNMP.
Cuando el modo de traducción de entidad y contexto se SNMPAPI_UNTRANSLATED_V1 o SNMPAPI_UNTRANSLATED_V2, la implementación también devuelve la cadena de la comunidad SNMP.
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 |