Función SnmpStrToContext (winsnmp.h)

Artículo
08/27/2023

[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 SnmpStrToContext de WinSNMP devuelve un identificador a la información de contexto SNMP específica de la implementación de Microsoft WinSNMP. El identificador es un valor válido que una aplicación WinSNMP puede usar como parámetro de contexto en una llamada a las funciones SnmpSendMsg y SnmpRegister .

Sintaxis

HSNMP_CONTEXT SNMPAPI_CALL SnmpStrToContext(
  [in] HSNMP_SESSION session,
  [in] smiLPCOCTETS  string
);

Parámetros

[in] session

Controle la sesión de WinSNMP.

[in] string

Puntero a una estructura smiOCTETS que contiene una cadena que se va a interpretar. La cadena puede identificar una colección de objetos administrados o puede ser una cadena de comunidad.

La configuración actual del modo de traducción de entidad y contexto determina la forma en que SnmpStrToContext interpreta la estructura de la cadena de entrada como se muestra en la tabla siguiente.

Modo de traducción de entidad/contexto	Significado
SNMPAPI_TRANSLATED	La implementación interpreta el parámetro de cadena como un nombre descriptivo para una colección de objetos administrados. La implementación traduce el nombre en sus componentes SNMPv1 o SNMPv2C mediante la base de datos de la implementación.
SNMPAPI_UNTRANSLATED_V1	La implementación interpreta el parámetro de cadena como una cadena de comunidad SNMP literal.
SNMPAPI_UNTRANSLATED_V2	La implementación interpreta el parámetro de cadena como una cadena de comunidad SNMP literal.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es un identificador para el contexto de interés.

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
SNMPAPI_NOT_INITIALIZED	La función SnmpStartup no se completó correctamente.
SNMPAPI_ALLOC_ERROR	Error durante la asignación de memoria.
SNMPAPI_SESSION_INVALID	El parámetro session no es válido.
SNMPAPI_CONTEXT_INVALID	El formato de parámetro de cadena no es válido. Por ejemplo, el miembro len o el miembro ptr de la estructura smiOCTETS a la que apunta el parámetro de cadena es NULL.
SNMPAPI_CONTEXT_UNKNOWN	El valor al que se hace referencia en el parámetro string no existe.
SNMPAPI_OTHER_ERROR	Error desconocido o indefinido.

Comentarios

La configuración actual del modo de traducción de entidad y contexto determina la manera en que SnmpStrToContext interpreta la estructura de la cadena de entrada. Para obtener más información, vea Establecer el modo de conversión de entidad y contexto.

La aplicación WinSNMP debe llamar a la función SnmpFreeContext para liberar el identificador de contexto asignado por la función SnmpStrToContext . Para obtener más información sobre cómo liberar recursos, consulte Conceptos de Administración de datos de WinSNMP.

La aplicación WinSNMP debe liberar la memoria asociada al miembro ptr de la estructura smiOCTETS a la que apunta el parámetro string . Esto se debe a que la aplicación define y asigna los recursos. Por ejemplo, si la aplicación asigna recursos con una llamada a la función GlobalAlloc , debe usar la función GlobalFree para desasignar los recursos. Para obtener más información, consulta Liberar descriptores winSNMP.

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