Función SnmpStartup (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 SnmpStartup notifica a la implementación de Microsoft WinSNMP que la aplicación WinSNMP requiere los servicios de la implementación. La función SnmpStartup de WinSNMP permite que la implementación inicialice y vuelva a la aplicación la versión de la interfaz de programación de aplicaciones SNMP de Windows (API winSNMP), el nivel de comunicaciones SNMP que admite la implementación y los modos de traducción y retransmisión predeterminados de la implementación.
Sintaxis
SNMPAPI_STATUS SNMPAPI_CALL SnmpStartup(
[out] smiLPUINT32 nMajorVersion,
[out] smiLPUINT32 nMinorVersion,
[out] smiLPUINT32 nLevel,
[out] smiLPUINT32 nTranslateMode,
[out] smiLPUINT32 nRetransmitMode
);
Parámetros
[out] nMajorVersion
Puntero a una variable de entero largo sin signo para recibir el número de versión principal de la API winSNMP que admite la implementación. Por ejemplo, para indicar que la implementación admite WinSNMP versión 2.0, la función devuelve un valor de 2.
[out] nMinorVersion
Puntero a una variable de entero largo sin signo para recibir el número de versión secundaria de la API winSNMP que admite la implementación. Por ejemplo, para indicar que la implementación admite WinSNMP versión 2.0, la función devuelve un valor de 0.
[out] nLevel
Puntero a una variable de entero largo sin signo para recibir el nivel más alto de comunicaciones SNMP que admite la implementación. Tras la devolución correcta, este parámetro contiene un valor de 2. Para obtener una descripción de la compatibilidad de nivel 2, consulte Niveles de compatibilidad con SNMP.
[out] nTranslateMode
Puntero a una variable de entero largo sin signo para recibir el modo de traducción predeterminado en vigor para la implementación. El modo de traducción se aplica a la interpretación de la implementación del parámetro de entidad que la aplicación WinSNMP pasa a la función SnmpStrToEntity . El modo de traducción también se aplica al parámetro de cadena que la aplicación WinSNMP pasa a la función SnmpStrToContext . Este parámetro puede ser uno de los valores siguientes.
Para obtener más información, vea Establecer el modo de conversión de entidad y contexto.
[out] nRetransmitMode
Puntero a una variable de entero largo sin signo para recibir el modo de retransmisión predeterminado en vigor para la implementación. Este parámetro puede ser uno de los valores siguientes.
Para obtener más información, consulte Acerca de la retransmisión.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es SNMPAPI_SUCCESS y los parámetros contienen los valores adecuados, como se indica en las descripciones de parámetros anteriores.
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. Para obtener más información, vea la sección Comentarios que se muestra a continuación.
| Código devuelto | Descripción |
|---|---|
|
La función SnmpStartup no se completó correctamente. |
|
Error durante la asignación de memoria. |
|
Error desconocido o indefinido. |
Comentarios
Una aplicación WinSNMP debe llamar a la función SnmpStartup correctamente al menos una vez, antes de llamar a cualquier otra función winSNMP. Si una aplicación WinSNMP llama a otra función winSNMP, antes de llamar correctamente a SnmpStartup, la implementación devuelve el error SNMPAPI_NOT_INITIALIZED.
La aplicación WinSNMP puede llamar a SnmpGetLastError para obtener información de error o reintentar SnmpStartup si se produce un error en una llamada a la función SnmpStartup . Cuando SnmpStartup devuelve SNMPAPI_FAILURE y una llamada posterior a SnmpGetLastError devuelve SNMP_ALLOC_ERROR, la aplicación WinSNMP puede optar por esperar. Puede reintentar la llamada a SnmpStartup cuando la implementación tenga recursos gratuitos adecuados.
Una aplicación WinSNMP puede llamar a SnmpStartup varias veces. Por ejemplo, puede que tenga que volver a intentar la llamada de función por los motivos descritos anteriormente. Una aplicación WinSNMP también debe llamar a SnmpCleanup al menos una vez, ya que la última llamada de función winSNMP antes de finalizar. Varias llamadas SnmpStartup no requieren varias llamadas SnmpCleanup .
Para obtener más información, vea Niveles de compatibilidad con SNMP y Acerca de las versiones de SNMP.
Requisitos
| Requisito | Value |
|---|---|
| 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 |