Win32 API 日本語リファレンス
ホーム › NetworkManagement.Snmp › SnmpCleanupEx

SnmpCleanupEx

関数
WinSNMP APIの拡張版終了処理を行いリソースを解放する。
DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// wsnmp32.dll
#include <windows.h>

DWORD SnmpCleanupEx(void);

パラメーターなし。戻り値: DWORD

公式ドキュメント

SnmpCleanupEx 関数は、Windows SNMP (WinSNMP) アプリケーション内で SnmpStartup または SnmpStartupEx に対する未処理の成功した呼び出しが残っていない場合に、クリーンアップを実行します。

戻り値

関数が成功した場合、戻り値は SNMPAPI_SUCCESS です。WinSNMP アプリケーションが対応する SnmpStartupEx 関数を再度正常に呼び出すまで、また SnmpStartup または SnmpStartupEx に対する未処理の成功した呼び出しが他にない間は、同じアプリケーション内で WinSNMP 関数を呼び出しても SNMPAPI_FAILURE が返され、拡張エラーコードは SNMPAPI_NOT_INITIALIZED になります。

関数が失敗した場合、戻り値は SNMPAPI_FAILURE ですが、WinSNMP アプリケーションが SnmpCleanupEx の呼び出しを再試行する必要はありません。拡張エラー情報を取得するには、session パラメーターに NULL 値を指定して SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことがあります。

リターンコード 説明
SNMPAPI_ALLOC_ERROR
メモリの割り当て中にエラーが発生しました。
SNMPAPI_OTHER_ERROR
SnmpStartupEx 関数が正常に完了しなかったか、不明または未定義のエラーが発生しました。

解説(Remarks)

WinSNMP アプリケーションは SnmpCleanupEx を呼び出す前に、SnmpCreateSession 関数の呼び出しによって実装が開いた各セッションについて、 SnmpClose 関数を 1 回ずつ呼び出す必要があります。

WinSNMP アプリケーションが SnmpCleanupEx 関数を呼び出したとき、SnmpStartup または SnmpStartupEx に対する未処理の成功した呼び出しも残っていなければ、実装はそのアプリケーションに割り当てられているすべてのリソースを解放します。ただし、WinSNMP アプリケーションは、実装が自身のために割り当てた個々のリソースを、そのリソースに対応する WinSNMP 関数で解放することをお勧めします。個々のリソースの解放について詳しくは、 SnmpFreeEntity、 SnmpFreeVbl、 SnmpFreeDescriptor、 SnmpFreeContext、および SnmpFreePdu を参照してください。

WinSNMP アプリケーションが緊急終了を行う必要があり、個々のリソースを解放せず、開いているすべてのセッションに対して SnmpClose を呼び出さずに SnmpCleanupEx を呼び出した場合でも、実装はその WinSNMP アプリケーションに割り当てられているすべてのリソースを解放します。ただし、実装でこの機能を有効にするには、アプリケーションは SnmpCleanupEx を呼び出す必要があります。

SnmpCleanupEx は、アプリケーションの DLL がアンロードされている最中に呼び出してはなりません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// wsnmp32.dll
#include <windows.h>

DWORD SnmpCleanupEx(void);
[DllImport("wsnmp32.dll", ExactSpelling = true)]
static extern uint SnmpCleanupEx();
<DllImport("wsnmp32.dll", ExactSpelling:=True)>
Public Shared Function SnmpCleanupEx() As UInteger
End Function
Declare PtrSafe Function SnmpCleanupEx Lib "wsnmp32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SnmpCleanupEx = ctypes.windll.wsnmp32.SnmpCleanupEx
SnmpCleanupEx.restype = wintypes.DWORD
SnmpCleanupEx.argtypes = []
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wsnmp32.dll')
SnmpCleanupEx = Fiddle::Function.new(
  lib['SnmpCleanupEx'],
  [],
  -Fiddle::TYPE_INT)
#[link(name = "wsnmp32")]
extern "system" {
    fn SnmpCleanupEx() -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wsnmp32.dll")]
public static extern uint SnmpCleanupEx();
"@
$api = Add-Type -MemberDefinition $sig -Name 'wsnmp32_SnmpCleanupEx' -Namespace Win32 -PassThru
# $api::SnmpCleanupEx()
#uselib "wsnmp32.dll"
#func global SnmpCleanupEx "SnmpCleanupEx"
; SnmpCleanupEx   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wsnmp32.dll"
#cfunc global SnmpCleanupEx "SnmpCleanupEx"
; res = SnmpCleanupEx()
; DWORD SnmpCleanupEx()
#uselib "wsnmp32.dll"
#cfunc global SnmpCleanupEx "SnmpCleanupEx"
; res = SnmpCleanupEx()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsnmp32 = windows.NewLazySystemDLL("wsnmp32.dll")
	procSnmpCleanupEx = wsnmp32.NewProc("SnmpCleanupEx")
)

r1, _, err := procSnmpCleanupEx.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SnmpCleanupEx: DWORD; stdcall;
  external 'wsnmp32.dll' name 'SnmpCleanupEx';
result := DllCall("wsnmp32\SnmpCleanupEx", "UInt")
●SnmpCleanupEx() = DLL("wsnmp32.dll", "dword SnmpCleanupEx()")
# 呼び出し: SnmpCleanupEx()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wsnmp32" fn SnmpCleanupEx() callconv(std.os.windows.WINAPI) u32;
proc SnmpCleanupEx(): uint32 {.importc: "SnmpCleanupEx", stdcall, dynlib: "wsnmp32.dll".}
pragma(lib, "wsnmp32");
extern(Windows)
uint SnmpCleanupEx();
ccall((:SnmpCleanupEx, "wsnmp32.dll"), stdcall, UInt32,
      (),
      )
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SnmpCleanupEx(void);
]]
local wsnmp32 = ffi.load("wsnmp32")
-- wsnmp32.SnmpCleanupEx()
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wsnmp32.dll');
const SnmpCleanupEx = lib.func('__stdcall', 'SnmpCleanupEx', 'uint32_t', []);
// SnmpCleanupEx()
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wsnmp32.dll", {
  SnmpCleanupEx: { parameters: [], result: "u32" },
});
// lib.symbols.SnmpCleanupEx()
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SnmpCleanupEx(void);
C, "wsnmp32.dll");
// $ffi->SnmpCleanupEx();
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wsnmp32 extends StdCallLibrary {
    Wsnmp32 INSTANCE = Native.load("wsnmp32", Wsnmp32.class);
    int SnmpCleanupEx();
}
@[Link("wsnmp32")]
lib Libwsnmp32
  fun SnmpCleanupEx = SnmpCleanupEx() : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SnmpCleanupExNative = Uint32 Function();
typedef SnmpCleanupExDart = int Function();
final SnmpCleanupEx = DynamicLibrary.open('wsnmp32.dll')
    .lookupFunction<SnmpCleanupExNative, SnmpCleanupExDart>('SnmpCleanupEx');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SnmpCleanupEx: DWORD; stdcall;
  external 'wsnmp32.dll' name 'SnmpCleanupEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SnmpCleanupEx"
  c_SnmpCleanupEx :: IO Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let snmpcleanupex =
  foreign "SnmpCleanupEx"
    (void @-> returning uint32_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsnmp32 (t "wsnmp32.dll"))
(cffi:use-foreign-library wsnmp32)

(cffi:defcfun ("SnmpCleanupEx" snmp-cleanup-ex :convention :stdcall) :uint32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpCleanupEx = Win32::API::More->new('wsnmp32',
    'DWORD SnmpCleanupEx()');
# my $ret = $SnmpCleanupEx->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目