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

SnmpMgrRequest

関数
SNMPエージェントに要求を送り変数バインドを取得する。
DLLmgmtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT SnmpMgrRequest(
    void* session,
    BYTE requestType,
    SnmpVarBindList* variableBindings,
    SNMP_ERROR_STATUS* errorStatus,
    INT* errorIndex
);

パラメーター

名前方向説明
sessionvoid*inoutSnmpMgrOpenで取得したセッションハンドル。
requestTypeBYTEin要求の種別(GET/GETNEXT/SET等)を示すPDU型コード。
variableBindingsSnmpVarBindList*inout送受信する変数バインドリスト。応答値で更新される。
errorStatusSNMP_ERROR_STATUS*inoutエージェント応答のエラーステータス(SNMP_ERROR_STATUS)を受け取る出力先。
errorIndexINT*inoutエラーが発生した変数バインドの1始まりインデックスを受け取るINTポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT SnmpMgrRequest(
    void* session,
    BYTE requestType,
    SnmpVarBindList* variableBindings,
    SNMP_ERROR_STATUS* errorStatus,
    INT* errorIndex
);
[DllImport("mgmtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern int SnmpMgrRequest(
    IntPtr session,   // void* in/out
    byte requestType,   // BYTE
    IntPtr variableBindings,   // SnmpVarBindList* in/out
    ref uint errorStatus,   // SNMP_ERROR_STATUS* in/out
    ref int errorIndex   // INT* in/out
);
<DllImport("mgmtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SnmpMgrRequest(
    session As IntPtr,   ' void* in/out
    requestType As Byte,   ' BYTE
    variableBindings As IntPtr,   ' SnmpVarBindList* in/out
    ByRef errorStatus As UInteger,   ' SNMP_ERROR_STATUS* in/out
    ByRef errorIndex As Integer   ' INT* in/out
) As Integer
End Function
' session : void* in/out
' requestType : BYTE
' variableBindings : SnmpVarBindList* in/out
' errorStatus : SNMP_ERROR_STATUS* in/out
' errorIndex : INT* in/out
Declare PtrSafe Function SnmpMgrRequest Lib "mgmtapi" ( _
    ByVal session As LongPtr, _
    ByVal requestType As Byte, _
    ByVal variableBindings As LongPtr, _
    ByRef errorStatus As Long, _
    ByRef errorIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SnmpMgrRequest = ctypes.windll.mgmtapi.SnmpMgrRequest
SnmpMgrRequest.restype = ctypes.c_int
SnmpMgrRequest.argtypes = [
    ctypes.POINTER(None),  # session : void* in/out
    ctypes.c_ubyte,  # requestType : BYTE
    ctypes.c_void_p,  # variableBindings : SnmpVarBindList* in/out
    ctypes.c_void_p,  # errorStatus : SNMP_ERROR_STATUS* in/out
    ctypes.POINTER(ctypes.c_int),  # errorIndex : INT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mgmtapi.dll')
SnmpMgrRequest = Fiddle::Function.new(
  lib['SnmpMgrRequest'],
  [
    Fiddle::TYPE_VOIDP,  # session : void* in/out
    -Fiddle::TYPE_CHAR,  # requestType : BYTE
    Fiddle::TYPE_VOIDP,  # variableBindings : SnmpVarBindList* in/out
    Fiddle::TYPE_VOIDP,  # errorStatus : SNMP_ERROR_STATUS* in/out
    Fiddle::TYPE_VOIDP,  # errorIndex : INT* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "mgmtapi")]
extern "system" {
    fn SnmpMgrRequest(
        session: *mut (),  // void* in/out
        requestType: u8,  // BYTE
        variableBindings: *mut SnmpVarBindList,  // SnmpVarBindList* in/out
        errorStatus: *mut u32,  // SNMP_ERROR_STATUS* in/out
        errorIndex: *mut i32  // INT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("mgmtapi.dll", SetLastError = true)]
public static extern int SnmpMgrRequest(IntPtr session, byte requestType, IntPtr variableBindings, ref uint errorStatus, ref int errorIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mgmtapi_SnmpMgrRequest' -Namespace Win32 -PassThru
# $api::SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex)
#uselib "mgmtapi.dll"
#func global SnmpMgrRequest "SnmpMgrRequest" sptr, sptr, sptr, sptr, sptr
; SnmpMgrRequest session, requestType, varptr(variableBindings), varptr(errorStatus), varptr(errorIndex)   ; 戻り値は stat
; session : void* in/out -> "sptr"
; requestType : BYTE -> "sptr"
; variableBindings : SnmpVarBindList* in/out -> "sptr"
; errorStatus : SNMP_ERROR_STATUS* in/out -> "sptr"
; errorIndex : INT* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "mgmtapi.dll"
#cfunc global SnmpMgrRequest "SnmpMgrRequest" sptr, int, var, var, var
; res = SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex)
; session : void* in/out -> "sptr"
; requestType : BYTE -> "int"
; variableBindings : SnmpVarBindList* in/out -> "var"
; errorStatus : SNMP_ERROR_STATUS* in/out -> "var"
; errorIndex : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT SnmpMgrRequest(void* session, BYTE requestType, SnmpVarBindList* variableBindings, SNMP_ERROR_STATUS* errorStatus, INT* errorIndex)
#uselib "mgmtapi.dll"
#cfunc global SnmpMgrRequest "SnmpMgrRequest" intptr, int, var, var, var
; res = SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex)
; session : void* in/out -> "intptr"
; requestType : BYTE -> "int"
; variableBindings : SnmpVarBindList* in/out -> "var"
; errorStatus : SNMP_ERROR_STATUS* in/out -> "var"
; errorIndex : INT* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mgmtapi = windows.NewLazySystemDLL("mgmtapi.dll")
	procSnmpMgrRequest = mgmtapi.NewProc("SnmpMgrRequest")
)

// session (void* in/out), requestType (BYTE), variableBindings (SnmpVarBindList* in/out), errorStatus (SNMP_ERROR_STATUS* in/out), errorIndex (INT* in/out)
r1, _, err := procSnmpMgrRequest.Call(
	uintptr(session),
	uintptr(requestType),
	uintptr(variableBindings),
	uintptr(errorStatus),
	uintptr(errorIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function SnmpMgrRequest(
  session: Pointer;   // void* in/out
  requestType: Byte;   // BYTE
  variableBindings: Pointer;   // SnmpVarBindList* in/out
  errorStatus: Pointer;   // SNMP_ERROR_STATUS* in/out
  errorIndex: Pointer   // INT* in/out
): Integer; stdcall;
  external 'mgmtapi.dll' name 'SnmpMgrRequest';
result := DllCall("mgmtapi\SnmpMgrRequest"
    , "Ptr", session   ; void* in/out
    , "UChar", requestType   ; BYTE
    , "Ptr", variableBindings   ; SnmpVarBindList* in/out
    , "Ptr", errorStatus   ; SNMP_ERROR_STATUS* in/out
    , "Ptr", errorIndex   ; INT* in/out
    , "Int")   ; return: INT
●SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex) = DLL("mgmtapi.dll", "int SnmpMgrRequest(void*, byte, void*, void*, void*)")
# 呼び出し: SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex)
# session : void* in/out -> "void*"
# requestType : BYTE -> "byte"
# variableBindings : SnmpVarBindList* in/out -> "void*"
# errorStatus : SNMP_ERROR_STATUS* in/out -> "void*"
# errorIndex : INT* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "mgmtapi" fn SnmpMgrRequest(
    session: ?*anyopaque, // void* in/out
    requestType: u8, // BYTE
    variableBindings: [*c]SnmpVarBindList, // SnmpVarBindList* in/out
    errorStatus: [*c]u32, // SNMP_ERROR_STATUS* in/out
    errorIndex: [*c]i32 // INT* in/out
) callconv(std.os.windows.WINAPI) i32;
proc SnmpMgrRequest(
    session: pointer,  # void* in/out
    requestType: uint8,  # BYTE
    variableBindings: ptr SnmpVarBindList,  # SnmpVarBindList* in/out
    errorStatus: ptr uint32,  # SNMP_ERROR_STATUS* in/out
    errorIndex: ptr int32  # INT* in/out
): int32 {.importc: "SnmpMgrRequest", stdcall, dynlib: "mgmtapi.dll".}
pragma(lib, "mgmtapi");
extern(Windows)
int SnmpMgrRequest(
    void* session,   // void* in/out
    ubyte requestType,   // BYTE
    SnmpVarBindList* variableBindings,   // SnmpVarBindList* in/out
    uint* errorStatus,   // SNMP_ERROR_STATUS* in/out
    int* errorIndex   // INT* in/out
);
ccall((:SnmpMgrRequest, "mgmtapi.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt8, Ptr{SnmpVarBindList}, Ptr{UInt32}, Ptr{Int32}),
      session, requestType, variableBindings, errorStatus, errorIndex)
# session : void* in/out -> Ptr{Cvoid}
# requestType : BYTE -> UInt8
# variableBindings : SnmpVarBindList* in/out -> Ptr{SnmpVarBindList}
# errorStatus : SNMP_ERROR_STATUS* in/out -> Ptr{UInt32}
# errorIndex : INT* in/out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SnmpMgrRequest(
    void* session,
    uint8_t requestType,
    void* variableBindings,
    uint32_t* errorStatus,
    int32_t* errorIndex);
]]
local mgmtapi = ffi.load("mgmtapi")
-- mgmtapi.SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex)
-- session : void* in/out
-- requestType : BYTE
-- variableBindings : SnmpVarBindList* in/out
-- errorStatus : SNMP_ERROR_STATUS* in/out
-- errorIndex : INT* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('mgmtapi.dll');
const SnmpMgrRequest = lib.func('__stdcall', 'SnmpMgrRequest', 'int32_t', ['void *', 'uint8_t', 'void *', 'uint32_t *', 'int32_t *']);
// SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex)
// session : void* in/out -> 'void *'
// requestType : BYTE -> 'uint8_t'
// variableBindings : SnmpVarBindList* in/out -> 'void *'
// errorStatus : SNMP_ERROR_STATUS* in/out -> 'uint32_t *'
// errorIndex : INT* in/out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("mgmtapi.dll", {
  SnmpMgrRequest: { parameters: ["pointer", "u8", "pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex)
// session : void* in/out -> "pointer"
// requestType : BYTE -> "u8"
// variableBindings : SnmpVarBindList* in/out -> "pointer"
// errorStatus : SNMP_ERROR_STATUS* in/out -> "pointer"
// errorIndex : INT* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SnmpMgrRequest(
    void* session,
    uint8_t requestType,
    void* variableBindings,
    uint32_t* errorStatus,
    int32_t* errorIndex);
C, "mgmtapi.dll");
// $ffi->SnmpMgrRequest(session, requestType, variableBindings, errorStatus, errorIndex);
// session : void* in/out
// requestType : BYTE
// variableBindings : SnmpVarBindList* in/out
// errorStatus : SNMP_ERROR_STATUS* in/out
// errorIndex : INT* 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);
    int SnmpMgrRequest(
        Pointer session,   // void* in/out
        byte requestType,   // BYTE
        Pointer variableBindings,   // SnmpVarBindList* in/out
        IntByReference errorStatus,   // SNMP_ERROR_STATUS* in/out
        IntByReference errorIndex   // INT* in/out
    );
}
@[Link("mgmtapi")]
lib Libmgmtapi
  fun SnmpMgrRequest = SnmpMgrRequest(
    session : Void*,   # void* in/out
    requestType : UInt8,   # BYTE
    variableBindings : SnmpVarBindList*,   # SnmpVarBindList* in/out
    errorStatus : UInt32*,   # SNMP_ERROR_STATUS* in/out
    errorIndex : Int32*   # INT* 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 SnmpMgrRequestNative = Int32 Function(Pointer<Void>, Uint8, Pointer<Void>, Pointer<Uint32>, Pointer<Int32>);
typedef SnmpMgrRequestDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Uint32>, Pointer<Int32>);
final SnmpMgrRequest = DynamicLibrary.open('mgmtapi.dll')
    .lookupFunction<SnmpMgrRequestNative, SnmpMgrRequestDart>('SnmpMgrRequest');
// session : void* in/out -> Pointer<Void>
// requestType : BYTE -> Uint8
// variableBindings : SnmpVarBindList* in/out -> Pointer<Void>
// errorStatus : SNMP_ERROR_STATUS* in/out -> Pointer<Uint32>
// errorIndex : INT* in/out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SnmpMgrRequest(
  session: Pointer;   // void* in/out
  requestType: Byte;   // BYTE
  variableBindings: Pointer;   // SnmpVarBindList* in/out
  errorStatus: Pointer;   // SNMP_ERROR_STATUS* in/out
  errorIndex: Pointer   // INT* in/out
): Integer; stdcall;
  external 'mgmtapi.dll' name 'SnmpMgrRequest';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SnmpMgrRequest"
  c_SnmpMgrRequest :: Ptr () -> Word8 -> Ptr () -> Ptr Word32 -> Ptr Int32 -> IO Int32
-- session : void* in/out -> Ptr ()
-- requestType : BYTE -> Word8
-- variableBindings : SnmpVarBindList* in/out -> Ptr ()
-- errorStatus : SNMP_ERROR_STATUS* in/out -> Ptr Word32
-- errorIndex : INT* in/out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let snmpmgrrequest =
  foreign "SnmpMgrRequest"
    ((ptr void) @-> uint8_t @-> (ptr void) @-> (ptr uint32_t) @-> (ptr int32_t) @-> returning int32_t)
(* session : void* in/out -> (ptr void) *)
(* requestType : BYTE -> uint8_t *)
(* variableBindings : SnmpVarBindList* in/out -> (ptr void) *)
(* errorStatus : SNMP_ERROR_STATUS* in/out -> (ptr uint32_t) *)
(* errorIndex : INT* in/out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mgmtapi (t "mgmtapi.dll"))
(cffi:use-foreign-library mgmtapi)

(cffi:defcfun ("SnmpMgrRequest" snmp-mgr-request :convention :stdcall) :int32
  (session :pointer)   ; void* in/out
  (request-type :uint8)   ; BYTE
  (variable-bindings :pointer)   ; SnmpVarBindList* in/out
  (error-status :pointer)   ; SNMP_ERROR_STATUS* in/out
  (error-index :pointer))   ; INT* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpMgrRequest = Win32::API::More->new('mgmtapi',
    'int SnmpMgrRequest(LPVOID session, BYTE requestType, LPVOID variableBindings, LPVOID errorStatus, LPVOID errorIndex)');
# my $ret = $SnmpMgrRequest->Call($session, $requestType, $variableBindings, $errorStatus, $errorIndex);
# session : void* in/out -> LPVOID
# requestType : BYTE -> BYTE
# variableBindings : SnmpVarBindList* in/out -> LPVOID
# errorStatus : SNMP_ERROR_STATUS* in/out -> LPVOID
# errorIndex : INT* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型