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

SnmpClose

関数
WinSNMPセッションを閉じて関連リソースを解放する。
DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SnmpClose(
    INT_PTR session
);

パラメーター

名前型方向説明
sessionINT_PTRin閉じる WinSNMP セッションのハンドル。

戻り値の型: DWORD

公式ドキュメント

SnmpClose 関数は、WinSNMP セッションに関連付けられたメモリ、リソース、およびデータ構造を Microsoft WinSNMP 実装が解放できるようにします。

戻り値

関数が成功した場合、戻り値は SNMPAPI_SUCCESS です。

関数が失敗した場合、戻り値は SNMPAPI_FAILURE です。拡張エラー情報を取得するには、 SnmpGetLastError の session パラメーターに NULL を指定して呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことがあります。

戻り値 説明
SNMPAPI_NOT_INITIALIZED
SnmpStartup 関数が正常に完了しませんでした。
SNMPAPI_ALLOC_ERROR
メモリの割り当て中にエラーが発生しました。
SNMPAPI_SESSION_INVALID
session パラメーターが無効です。
SNMPAPI_OTHER_ERROR
不明または未定義のエラーが発生しました。

解説(Remarks)

WinSNMP アプリケーションは、 SnmpCreateSession 関数を使用して開いたセッションごとに 1 回ずつ SnmpClose 関数を呼び出すことをお勧めします。WinSNMP アプリケーションが予期せず終了する場合は、実装がすべてのリソースを解放できるように、終了する前に SnmpCleanup を呼び出す必要があります。実装は、1 回の SnmpCleanup 呼び出しを、 SnmpCreateSession の呼び出しによって開かれた各セッションに対する SnmpClose 呼び出しの連続として処理します。

実装がセッションを閉じると、そのセッションに関して未処理の送受信中の非同期要求および応答はすべて破棄されます。詳細については、 WinSNMP Sessions を参照してください。

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

各言語での呼び出し定義

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

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

SnmpClose = ctypes.windll.wsnmp32.SnmpClose
SnmpClose.restype = wintypes.DWORD
SnmpClose.argtypes = [
    ctypes.c_ssize_t,  # session : INT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wsnmp32 = windows.NewLazySystemDLL("wsnmp32.dll")
	procSnmpClose = wsnmp32.NewProc("SnmpClose")
)

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

extern "wsnmp32" fn SnmpClose(
    session: isize // INT_PTR
) callconv(std.os.windows.WINAPI) u32;
proc SnmpClose(
    session: int  # INT_PTR
): uint32 {.importc: "SnmpClose", stdcall, dynlib: "wsnmp32.dll".}
pragma(lib, "wsnmp32");
extern(Windows)
uint SnmpClose(
    ptrdiff_t session   // INT_PTR
);
ccall((:SnmpClose, "wsnmp32.dll"), stdcall, UInt32,
      (Int,),
      session)
# session : INT_PTR -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SnmpClose(
    intptr_t session);
]]
local wsnmp32 = ffi.load("wsnmp32")
-- wsnmp32.SnmpClose(session)
-- session : INT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wsnmp32.dll');
const SnmpClose = lib.func('__stdcall', 'SnmpClose', 'uint32_t', ['intptr_t']);
// SnmpClose(session)
// session : INT_PTR -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wsnmp32.dll", {
  SnmpClose: { parameters: ["isize"], result: "u32" },
});
// lib.symbols.SnmpClose(session)
// session : INT_PTR -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SnmpClose(
    intptr_t session);
C, "wsnmp32.dll");
// $ffi->SnmpClose(session);
// session : INT_PTR
// 構造体/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 SnmpClose(
        long session   // INT_PTR
    );
}
@[Link("wsnmp32")]
lib Libwsnmp32
  fun SnmpClose = SnmpClose(
    session : LibC::SSizeT   # INT_PTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

公式の関連項目