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

SnmpSendMsg

関数
WinSNMPでPDUを含むメッセージを宛先へ送信する。
DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SnmpSendMsg(
    INT_PTR session,
    INT_PTR srcEntity,
    INT_PTR dstEntity,
    INT_PTR context,
    INT_PTR PDU
);

パラメーター

名前型方向説明
sessionINT_PTRinWinSNMP セッションのハンドル。
srcEntityINT_PTRinSNMP メッセージの送信要求を開始する管理エンティティのハンドル。
dstEntityINT_PTRinSNMP 要求に応答するターゲットエンティティのハンドル。
contextINT_PTRinターゲット管理エンティティが制御するコンテキスト (管理対象オブジェクトリソースの集合) のハンドル。
PDUINT_PTRinSNMP 操作要求を格納するプロトコルデータユニットのハンドル。

戻り値の型: DWORD

公式ドキュメント

WinSNMP アプリケーションは、SNMP メッセージの形式で SNMP プロトコルデータユニット (PDU) を送信するよう Microsoft WinSNMP 実装に要求するために、SnmpSendMsg 関数を呼び出します。

戻り値

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

関数が失敗した場合、戻り値は SNMPAPI_FAILURE です。拡張エラー情報を取得するには、 SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次の WinSNMP エラーまたはネットワークトランスポート層エラーのいずれかを返すことがあります。

リターンコード 説明
SNMPAPI_NOT_INITIALIZED
SnmpStartup 関数が正常に完了しませんでした。
SNMPAPI_ALLOC_ERROR
メモリの割り当て中にエラーが発生しました。
SNMPAPI_SESSION_INVALID
session パラメーターが無効です。
SNMPAPI_ENTITY_INVALID
エンティティのパラメーターの一方または両方が無効です。
SNMPAPI_CONTEXT_INVALID
context パラメーターが無効です。
SNMPAPI_PDU_INVALID
PDU パラメーターが無効です。
SNMPAPI_OPERATION_INVALID
PDU の PDU_type フィールドで指定された操作が、宛先エンティティに対して適切ではありません。詳細については、後述の「解説」セクションを参照してください。
SNMPAPI_TL_NOT_INITIALIZED
ネットワークトランスポート層が初期化されていませんでした。
SNMPAPI_TL_NOT_SUPPORTED
ネットワークトランスポート層が SNMP プロトコルをサポートしていません。
SNMPAPI_TL_NOT_AVAILABLE
ネットワークサブシステムが失敗しました。
SNMPAPI_TL_RESOURCE_ERROR
ネットワークトランスポート層でリソースエラーが発生しました。
SNMPAPI_TL_SRC_INVALID
srcEntity パラメーターで指定されたエンティティが初期化されていませんでした。
SNMPAPI_TL_INVALID_PARAM
ネットワークトランスポート層の関数呼び出しが無効な入力パラメーターを受け取りました。
SNMPAPI_TL_PDU_TOO_BIG
PDU が大きすぎるため、ネットワークトランスポート層で送受信できません。
SNMPAPI_TL_OTHER
定義されていないネットワークトランスポート層エラーが発生しました。
SNMPAPI_OTHER_ERROR
不明または未定義のエラーが発生しました。

詳細については、 Network Transport Errors を参照してください。

解説(Remarks)

SnmpSendMsg 関数は非同期に実行されるため、すぐに制御を返します。

非同期要求が完了すると、実装は WinSNMP アプリケーションに通知します。実装は、そのセッションに対する最初の SnmpCreateSession の呼び出しで wMsg パラメーターおよび hWnd パラメーターにそれぞれ指定されたウィンドウへ通知メッセージを送信することで、これを行います。アプリケーションのウィンドウが通知メッセージを受け取ったら、WinSNMP アプリケーションは受信した PDU を取得する必要があります。アプリケーションは、 SnmpCreateSession が返したセッションハンドルを指定して SnmpRecvMsg 関数を呼び出すことで、これを行います。

WinSNMP アプリケーションが SnmpSendMsg 関数を呼び出すと、実装は送信要求を完了するために使用するネットワークトランスポートプロトコルと SNMP バージョンフレームワークを決定します。実装は、自身の機能を、要求元のセッションおよびターゲット管理エンティティに関連付けられたプロパティと照合することで、これを決定します。この情報は、実装のデータベース内の値から取得できます。

WinSNMP アプリケーションが SNMP バージョン 2C フレームワーク (SNMPv2C) で利用可能な機能を要求したものの、ターゲットエンティティが SNMP バージョン 1 フレームワーク (SNMPv1) を使用している場合、実装はその要求を SNMPv1 に変換しようとします。このために、実装は RFC1908「Coexistence between Version 1 and Version 2 of the Internet-standard Network Management Framework」で定義された手順を使用します。変換できない場合、 SnmpSendMsg は失敗し、拡張エラーコードは SNMPAPI_OPERATION_INVALID になります。この状況は、たとえばアプリケーションが SNMP_PDU_InformRequest データ型の PDU を SNMPv1 の宛先エンティティに送信しようとした場合に発生します。

詳細については、 WinSNMP Programming Tasks および About SNMP Messages を参照してください。

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

各言語での呼び出し定義

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

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

SnmpSendMsg = ctypes.windll.wsnmp32.SnmpSendMsg
SnmpSendMsg.restype = wintypes.DWORD
SnmpSendMsg.argtypes = [
    ctypes.c_ssize_t,  # session : INT_PTR
    ctypes.c_ssize_t,  # srcEntity : INT_PTR
    ctypes.c_ssize_t,  # dstEntity : INT_PTR
    ctypes.c_ssize_t,  # context : INT_PTR
    ctypes.c_ssize_t,  # PDU : INT_PTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wsnmp32 = windows.NewLazySystemDLL("wsnmp32.dll")
	procSnmpSendMsg = wsnmp32.NewProc("SnmpSendMsg")
)

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

extern "wsnmp32" fn SnmpSendMsg(
    session: isize, // INT_PTR
    srcEntity: isize, // INT_PTR
    dstEntity: isize, // INT_PTR
    context: isize, // INT_PTR
    PDU: isize // INT_PTR
) callconv(std.os.windows.WINAPI) u32;
proc SnmpSendMsg(
    session: int,  # INT_PTR
    srcEntity: int,  # INT_PTR
    dstEntity: int,  # INT_PTR
    context: int,  # INT_PTR
    PDU: int  # INT_PTR
): uint32 {.importc: "SnmpSendMsg", stdcall, dynlib: "wsnmp32.dll".}
pragma(lib, "wsnmp32");
extern(Windows)
uint SnmpSendMsg(
    ptrdiff_t session,   // INT_PTR
    ptrdiff_t srcEntity,   // INT_PTR
    ptrdiff_t dstEntity,   // INT_PTR
    ptrdiff_t context,   // INT_PTR
    ptrdiff_t PDU   // INT_PTR
);
ccall((:SnmpSendMsg, "wsnmp32.dll"), stdcall, UInt32,
      (Int, Int, Int, Int, Int),
      session, srcEntity, dstEntity, context, PDU)
# session : INT_PTR -> Int
# srcEntity : INT_PTR -> Int
# dstEntity : INT_PTR -> Int
# context : INT_PTR -> Int
# PDU : INT_PTR -> Int
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SnmpSendMsg(
    intptr_t session,
    intptr_t srcEntity,
    intptr_t dstEntity,
    intptr_t context,
    intptr_t PDU);
]]
local wsnmp32 = ffi.load("wsnmp32")
-- wsnmp32.SnmpSendMsg(session, srcEntity, dstEntity, context, PDU)
-- session : INT_PTR
-- srcEntity : INT_PTR
-- dstEntity : INT_PTR
-- context : INT_PTR
-- PDU : INT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wsnmp32.dll');
const SnmpSendMsg = lib.func('__stdcall', 'SnmpSendMsg', 'uint32_t', ['intptr_t', 'intptr_t', 'intptr_t', 'intptr_t', 'intptr_t']);
// SnmpSendMsg(session, srcEntity, dstEntity, context, PDU)
// session : INT_PTR -> 'intptr_t'
// srcEntity : INT_PTR -> 'intptr_t'
// dstEntity : INT_PTR -> 'intptr_t'
// context : INT_PTR -> 'intptr_t'
// PDU : INT_PTR -> 'intptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wsnmp32.dll", {
  SnmpSendMsg: { parameters: ["isize", "isize", "isize", "isize", "isize"], result: "u32" },
});
// lib.symbols.SnmpSendMsg(session, srcEntity, dstEntity, context, PDU)
// session : INT_PTR -> "isize"
// srcEntity : INT_PTR -> "isize"
// dstEntity : INT_PTR -> "isize"
// context : INT_PTR -> "isize"
// PDU : INT_PTR -> "isize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SnmpSendMsg(
    intptr_t session,
    intptr_t srcEntity,
    intptr_t dstEntity,
    intptr_t context,
    intptr_t PDU);
C, "wsnmp32.dll");
// $ffi->SnmpSendMsg(session, srcEntity, dstEntity, context, PDU);
// session : INT_PTR
// srcEntity : INT_PTR
// dstEntity : INT_PTR
// context : INT_PTR
// PDU : 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 SnmpSendMsg(
        long session,   // INT_PTR
        long srcEntity,   // INT_PTR
        long dstEntity,   // INT_PTR
        long context,   // INT_PTR
        long PDU   // INT_PTR
    );
}
@[Link("wsnmp32")]
lib Libwsnmp32
  fun SnmpSendMsg = SnmpSendMsg(
    session : LibC::SSizeT,   # INT_PTR
    srcEntity : LibC::SSizeT,   # INT_PTR
    dstEntity : LibC::SSizeT,   # INT_PTR
    context : LibC::SSizeT,   # INT_PTR
    PDU : 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 SnmpSendMsgNative = Uint32 Function(IntPtr, IntPtr, IntPtr, IntPtr, IntPtr);
typedef SnmpSendMsgDart = int Function(int, int, int, int, int);
final SnmpSendMsg = DynamicLibrary.open('wsnmp32.dll')
    .lookupFunction<SnmpSendMsgNative, SnmpSendMsgDart>('SnmpSendMsg');
// session : INT_PTR -> IntPtr
// srcEntity : INT_PTR -> IntPtr
// dstEntity : INT_PTR -> IntPtr
// context : INT_PTR -> IntPtr
// PDU : INT_PTR -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SnmpSendMsg(
  session: NativeInt;   // INT_PTR
  srcEntity: NativeInt;   // INT_PTR
  dstEntity: NativeInt;   // INT_PTR
  context: NativeInt;   // INT_PTR
  PDU: NativeInt   // INT_PTR
): DWORD; stdcall;
  external 'wsnmp32.dll' name 'SnmpSendMsg';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let snmpsendmsg =
  foreign "SnmpSendMsg"
    (intptr_t @-> intptr_t @-> intptr_t @-> intptr_t @-> intptr_t @-> returning uint32_t)
(* session : INT_PTR -> intptr_t *)
(* srcEntity : INT_PTR -> intptr_t *)
(* dstEntity : INT_PTR -> intptr_t *)
(* context : INT_PTR -> intptr_t *)
(* PDU : 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 ("SnmpSendMsg" snmp-send-msg :convention :stdcall) :uint32
  (session :int64)   ; INT_PTR
  (src-entity :int64)   ; INT_PTR
  (dst-entity :int64)   ; INT_PTR
  (context :int64)   ; INT_PTR
  (pdu :int64))   ; INT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpSendMsg = Win32::API::More->new('wsnmp32',
    'DWORD SnmpSendMsg(LPARAM session, LPARAM srcEntity, LPARAM dstEntity, LPARAM context, LPARAM PDU)');
# my $ret = $SnmpSendMsg->Call($session, $srcEntity, $dstEntity, $context, $PDU);
# session : INT_PTR -> LPARAM
# srcEntity : INT_PTR -> LPARAM
# dstEntity : INT_PTR -> LPARAM
# context : INT_PTR -> LPARAM
# PDU : INT_PTR -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目