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

SnmpMgrCtl

関数
SNMP管理セッションに対し制御コードを発行し操作する。
DLLmgmtapi.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SnmpMgrCtl(
    void* session,
    DWORD dwCtlCode,
    void* lpvInBuffer,
    DWORD cbInBuffer,
    void* lpvOUTBuffer,
    DWORD cbOUTBuffer,
    DWORD* lpcbBytesReturned
);

パラメーター

名前方向
sessionvoid*inout
dwCtlCodeDWORDin
lpvInBuffervoid*inout
cbInBufferDWORDin
lpvOUTBuffervoid*inout
cbOUTBufferDWORDin
lpcbBytesReturnedDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SnmpMgrCtl(
    void* session,
    DWORD dwCtlCode,
    void* lpvInBuffer,
    DWORD cbInBuffer,
    void* lpvOUTBuffer,
    DWORD cbOUTBuffer,
    DWORD* lpcbBytesReturned
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("mgmtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SnmpMgrCtl(
    IntPtr session,   // void* in/out
    uint dwCtlCode,   // DWORD
    IntPtr lpvInBuffer,   // void* in/out
    uint cbInBuffer,   // DWORD
    IntPtr lpvOUTBuffer,   // void* in/out
    uint cbOUTBuffer,   // DWORD
    ref uint lpcbBytesReturned   // DWORD* in/out
);
<DllImport("mgmtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SnmpMgrCtl(
    session As IntPtr,   ' void* in/out
    dwCtlCode As UInteger,   ' DWORD
    lpvInBuffer As IntPtr,   ' void* in/out
    cbInBuffer As UInteger,   ' DWORD
    lpvOUTBuffer As IntPtr,   ' void* in/out
    cbOUTBuffer As UInteger,   ' DWORD
    ByRef lpcbBytesReturned As UInteger   ' DWORD* in/out
) As Boolean
End Function
' session : void* in/out
' dwCtlCode : DWORD
' lpvInBuffer : void* in/out
' cbInBuffer : DWORD
' lpvOUTBuffer : void* in/out
' cbOUTBuffer : DWORD
' lpcbBytesReturned : DWORD* in/out
Declare PtrSafe Function SnmpMgrCtl Lib "mgmtapi" ( _
    ByVal session As LongPtr, _
    ByVal dwCtlCode As Long, _
    ByVal lpvInBuffer As LongPtr, _
    ByVal cbInBuffer As Long, _
    ByVal lpvOUTBuffer As LongPtr, _
    ByVal cbOUTBuffer As Long, _
    ByRef lpcbBytesReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SnmpMgrCtl = ctypes.windll.mgmtapi.SnmpMgrCtl
SnmpMgrCtl.restype = wintypes.BOOL
SnmpMgrCtl.argtypes = [
    ctypes.POINTER(None),  # session : void* in/out
    wintypes.DWORD,  # dwCtlCode : DWORD
    ctypes.POINTER(None),  # lpvInBuffer : void* in/out
    wintypes.DWORD,  # cbInBuffer : DWORD
    ctypes.POINTER(None),  # lpvOUTBuffer : void* in/out
    wintypes.DWORD,  # cbOUTBuffer : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpcbBytesReturned : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mgmtapi.dll')
SnmpMgrCtl = Fiddle::Function.new(
  lib['SnmpMgrCtl'],
  [
    Fiddle::TYPE_VOIDP,  # session : void* in/out
    -Fiddle::TYPE_INT,  # dwCtlCode : DWORD
    Fiddle::TYPE_VOIDP,  # lpvInBuffer : void* in/out
    -Fiddle::TYPE_INT,  # cbInBuffer : DWORD
    Fiddle::TYPE_VOIDP,  # lpvOUTBuffer : void* in/out
    -Fiddle::TYPE_INT,  # cbOUTBuffer : DWORD
    Fiddle::TYPE_VOIDP,  # lpcbBytesReturned : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "mgmtapi")]
extern "system" {
    fn SnmpMgrCtl(
        session: *mut (),  // void* in/out
        dwCtlCode: u32,  // DWORD
        lpvInBuffer: *mut (),  // void* in/out
        cbInBuffer: u32,  // DWORD
        lpvOUTBuffer: *mut (),  // void* in/out
        cbOUTBuffer: u32,  // DWORD
        lpcbBytesReturned: *mut u32  // DWORD* 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 SnmpMgrCtl(IntPtr session, uint dwCtlCode, IntPtr lpvInBuffer, uint cbInBuffer, IntPtr lpvOUTBuffer, uint cbOUTBuffer, ref uint lpcbBytesReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mgmtapi_SnmpMgrCtl' -Namespace Win32 -PassThru
# $api::SnmpMgrCtl(session, dwCtlCode, lpvInBuffer, cbInBuffer, lpvOUTBuffer, cbOUTBuffer, lpcbBytesReturned)
#uselib "mgmtapi.dll"
#func global SnmpMgrCtl "SnmpMgrCtl" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SnmpMgrCtl session, dwCtlCode, lpvInBuffer, cbInBuffer, lpvOUTBuffer, cbOUTBuffer, varptr(lpcbBytesReturned)   ; 戻り値は stat
; session : void* in/out -> "sptr"
; dwCtlCode : DWORD -> "sptr"
; lpvInBuffer : void* in/out -> "sptr"
; cbInBuffer : DWORD -> "sptr"
; lpvOUTBuffer : void* in/out -> "sptr"
; cbOUTBuffer : DWORD -> "sptr"
; lpcbBytesReturned : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "mgmtapi.dll"
#cfunc global SnmpMgrCtl "SnmpMgrCtl" sptr, int, sptr, int, sptr, int, var
; res = SnmpMgrCtl(session, dwCtlCode, lpvInBuffer, cbInBuffer, lpvOUTBuffer, cbOUTBuffer, lpcbBytesReturned)
; session : void* in/out -> "sptr"
; dwCtlCode : DWORD -> "int"
; lpvInBuffer : void* in/out -> "sptr"
; cbInBuffer : DWORD -> "int"
; lpvOUTBuffer : void* in/out -> "sptr"
; cbOUTBuffer : DWORD -> "int"
; lpcbBytesReturned : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SnmpMgrCtl(void* session, DWORD dwCtlCode, void* lpvInBuffer, DWORD cbInBuffer, void* lpvOUTBuffer, DWORD cbOUTBuffer, DWORD* lpcbBytesReturned)
#uselib "mgmtapi.dll"
#cfunc global SnmpMgrCtl "SnmpMgrCtl" intptr, int, intptr, int, intptr, int, var
; res = SnmpMgrCtl(session, dwCtlCode, lpvInBuffer, cbInBuffer, lpvOUTBuffer, cbOUTBuffer, lpcbBytesReturned)
; session : void* in/out -> "intptr"
; dwCtlCode : DWORD -> "int"
; lpvInBuffer : void* in/out -> "intptr"
; cbInBuffer : DWORD -> "int"
; lpvOUTBuffer : void* in/out -> "intptr"
; cbOUTBuffer : DWORD -> "int"
; lpcbBytesReturned : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mgmtapi = windows.NewLazySystemDLL("mgmtapi.dll")
	procSnmpMgrCtl = mgmtapi.NewProc("SnmpMgrCtl")
)

// session (void* in/out), dwCtlCode (DWORD), lpvInBuffer (void* in/out), cbInBuffer (DWORD), lpvOUTBuffer (void* in/out), cbOUTBuffer (DWORD), lpcbBytesReturned (DWORD* in/out)
r1, _, err := procSnmpMgrCtl.Call(
	uintptr(session),
	uintptr(dwCtlCode),
	uintptr(lpvInBuffer),
	uintptr(cbInBuffer),
	uintptr(lpvOUTBuffer),
	uintptr(cbOUTBuffer),
	uintptr(lpcbBytesReturned),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SnmpMgrCtl(
  session: Pointer;   // void* in/out
  dwCtlCode: DWORD;   // DWORD
  lpvInBuffer: Pointer;   // void* in/out
  cbInBuffer: DWORD;   // DWORD
  lpvOUTBuffer: Pointer;   // void* in/out
  cbOUTBuffer: DWORD;   // DWORD
  lpcbBytesReturned: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'mgmtapi.dll' name 'SnmpMgrCtl';
result := DllCall("mgmtapi\SnmpMgrCtl"
    , "Ptr", session   ; void* in/out
    , "UInt", dwCtlCode   ; DWORD
    , "Ptr", lpvInBuffer   ; void* in/out
    , "UInt", cbInBuffer   ; DWORD
    , "Ptr", lpvOUTBuffer   ; void* in/out
    , "UInt", cbOUTBuffer   ; DWORD
    , "Ptr", lpcbBytesReturned   ; DWORD* in/out
    , "Int")   ; return: BOOL
●SnmpMgrCtl(session, dwCtlCode, lpvInBuffer, cbInBuffer, lpvOUTBuffer, cbOUTBuffer, lpcbBytesReturned) = DLL("mgmtapi.dll", "bool SnmpMgrCtl(void*, dword, void*, dword, void*, dword, void*)")
# 呼び出し: SnmpMgrCtl(session, dwCtlCode, lpvInBuffer, cbInBuffer, lpvOUTBuffer, cbOUTBuffer, lpcbBytesReturned)
# session : void* in/out -> "void*"
# dwCtlCode : DWORD -> "dword"
# lpvInBuffer : void* in/out -> "void*"
# cbInBuffer : DWORD -> "dword"
# lpvOUTBuffer : void* in/out -> "void*"
# cbOUTBuffer : DWORD -> "dword"
# lpcbBytesReturned : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。