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

SnmpMgrTrapListen

関数
SNMPトラップ受信を登録し通知用イベントを取得する。
DLLmgmtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SnmpMgrTrapListen(
    HANDLE* phTrapAvailable
);

パラメーター

名前型方向説明
phTrapAvailableHANDLE*inout利用可能なトラップが存在し、アプリケーションが SnmpMgrGetTrap 関数を呼び出す必要があることを通知するイベントハンドルへのポインター。

戻り値の型: BOOL

公式ドキュメント

SnmpMgrTrapListen 関数は、SNMP マネージャーアプリケーションが SNMP トラップサービスから SNMP トラップを受信できるように登録します。この関数は SNMP Management API の要素です。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。次のいずれかのエラーコードが返されることがあります。

戻り値 説明
SNMP_MEM_ALLOC_ERROR
メモリ割り当てエラーが発生したことを示します。
SNMP_MGMTAPI_TRAP_DUPINIT
この関数が既に呼び出されていることを示します。
SNMP_MGMTAPI_TRAP_ERRORS
1 つ以上のエラーが発生し、トラップにアクセスできないことを示します。アプリケーションはこの関数を再度呼び出すことができます。

この関数は、その他のシステムエラーを返すこともあります。

解説(Remarks)

管理者ではないユーザーの場合、 SnmpMgrTrapListen 関数は SNMP トラップサービスが開始されているときにのみ成功する点に注意してください。

アプリケーションは、 SnmpMgrGetTrap 関数を呼び出す前に、必ず SnmpMgrTrapListen 関数を呼び出す必要があります。これは、phTrapAvailable パラメーターが指すイベントハンドルによって、イベント駆動型の SNMP トラップ取得が可能になるためです。SNMP Management API は、SNMP トラップサービスがトラップを配信したときに、アプリケーションのイベントをシグナル状態にします。

アプリケーションは、一定の間隔で SnmpMgrGetTrap 関数をポーリングしてトラップを取得することもできます。この場合、アプリケーションは関数が 0 を返すまで SnmpMgrGetTrap を繰り返し呼び出す必要があります。

Windows Server 2003: SNMP マネージャーアプリケーションは、session パラメーターに NULL を指定して SnmpMgrClose を呼び出すことで、 SnmpMgrTrapListen 関数の呼び出しが成功したときに関連付けられたリソースをクリーンアップできます。ただし、アプリケーションが DLL の場合は、 DllMain エントリポイント関数から SnmpMgrClose を呼び出さないでください。

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

各言語での呼び出し定義

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

BOOL SnmpMgrTrapListen(
    HANDLE* phTrapAvailable
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mgmtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SnmpMgrTrapListen(
    IntPtr phTrapAvailable   // HANDLE* in/out
);
<DllImport("mgmtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SnmpMgrTrapListen(
    phTrapAvailable As IntPtr   ' HANDLE* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' phTrapAvailable : HANDLE* in/out
Declare PtrSafe Function SnmpMgrTrapListen Lib "mgmtapi" ( _
    ByVal phTrapAvailable As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SnmpMgrTrapListen = ctypes.windll.mgmtapi.SnmpMgrTrapListen
SnmpMgrTrapListen.restype = wintypes.BOOL
SnmpMgrTrapListen.argtypes = [
    ctypes.c_void_p,  # phTrapAvailable : HANDLE* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mgmtapi.dll')
SnmpMgrTrapListen = Fiddle::Function.new(
  lib['SnmpMgrTrapListen'],
  [
    Fiddle::TYPE_VOIDP,  # phTrapAvailable : HANDLE* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "mgmtapi")]
extern "system" {
    fn SnmpMgrTrapListen(
        phTrapAvailable: *mut *mut core::ffi::c_void  // HANDLE* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mgmtapi.dll", SetLastError = true)]
public static extern bool SnmpMgrTrapListen(IntPtr phTrapAvailable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mgmtapi_SnmpMgrTrapListen' -Namespace Win32 -PassThru
# $api::SnmpMgrTrapListen(phTrapAvailable)
#uselib "mgmtapi.dll"
#func global SnmpMgrTrapListen "SnmpMgrTrapListen" sptr
; SnmpMgrTrapListen phTrapAvailable   ; 戻り値は stat
; phTrapAvailable : HANDLE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "mgmtapi.dll"
#cfunc global SnmpMgrTrapListen "SnmpMgrTrapListen" sptr
; res = SnmpMgrTrapListen(phTrapAvailable)
; phTrapAvailable : HANDLE* in/out -> "sptr"
; BOOL SnmpMgrTrapListen(HANDLE* phTrapAvailable)
#uselib "mgmtapi.dll"
#cfunc global SnmpMgrTrapListen "SnmpMgrTrapListen" intptr
; res = SnmpMgrTrapListen(phTrapAvailable)
; phTrapAvailable : HANDLE* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mgmtapi = windows.NewLazySystemDLL("mgmtapi.dll")
	procSnmpMgrTrapListen = mgmtapi.NewProc("SnmpMgrTrapListen")
)

// phTrapAvailable (HANDLE* in/out)
r1, _, err := procSnmpMgrTrapListen.Call(
	uintptr(phTrapAvailable),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SnmpMgrTrapListen(
  phTrapAvailable: Pointer   // HANDLE* in/out
): BOOL; stdcall;
  external 'mgmtapi.dll' name 'SnmpMgrTrapListen';
result := DllCall("mgmtapi\SnmpMgrTrapListen"
    , "Ptr", phTrapAvailable   ; HANDLE* in/out
    , "Int")   ; return: BOOL
●SnmpMgrTrapListen(phTrapAvailable) = DLL("mgmtapi.dll", "bool SnmpMgrTrapListen(void*)")
# 呼び出し: SnmpMgrTrapListen(phTrapAvailable)
# phTrapAvailable : HANDLE* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SnmpMgrTrapListenNative = Int32 Function(Pointer<Void>);
typedef SnmpMgrTrapListenDart = int Function(Pointer<Void>);
final SnmpMgrTrapListen = DynamicLibrary.open('mgmtapi.dll')
    .lookupFunction<SnmpMgrTrapListenNative, SnmpMgrTrapListenDart>('SnmpMgrTrapListen');
// phTrapAvailable : HANDLE* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SnmpMgrTrapListen(
  phTrapAvailable: Pointer   // HANDLE* in/out
): BOOL; stdcall;
  external 'mgmtapi.dll' name 'SnmpMgrTrapListen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SnmpMgrTrapListen"
  c_SnmpMgrTrapListen :: Ptr () -> IO CInt
-- phTrapAvailable : HANDLE* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let snmpmgrtraplisten =
  foreign "SnmpMgrTrapListen"
    ((ptr void) @-> returning int32_t)
(* phTrapAvailable : HANDLE* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mgmtapi (t "mgmtapi.dll"))
(cffi:use-foreign-library mgmtapi)

(cffi:defcfun ("SnmpMgrTrapListen" snmp-mgr-trap-listen :convention :stdcall) :int32
  (ph-trap-available :pointer))   ; HANDLE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpMgrTrapListen = Win32::API::More->new('mgmtapi',
    'BOOL SnmpMgrTrapListen(HANDLE phTrapAvailable)');
# my $ret = $SnmpMgrTrapListen->Call($phTrapAvailable);
# phTrapAvailable : HANDLE* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目