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

SnmpEncodeMsg

関数
WinSNMPでメッセージをエンコードしバイト列を生成する。
DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SnmpEncodeMsg(
    INT_PTR session,
    INT_PTR srcEntity,
    INT_PTR dstEntity,
    INT_PTR context,
    INT_PTR pdu,
    smiOCTETS* msgBufDesc
);

パラメーター

名前方向
sessionINT_PTRin
srcEntityINT_PTRin
dstEntityINT_PTRin
contextINT_PTRin
pduINT_PTRin
msgBufDescsmiOCTETS*inout

戻り値の型: DWORD

各言語での呼び出し定義

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

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

SnmpEncodeMsg = ctypes.windll.wsnmp32.SnmpEncodeMsg
SnmpEncodeMsg.restype = wintypes.DWORD
SnmpEncodeMsg.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
    ctypes.c_void_p,  # msgBufDesc : smiOCTETS* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wsnmp32.dll')
SnmpEncodeMsg = Fiddle::Function.new(
  lib['SnmpEncodeMsg'],
  [
    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_VOIDP,  # msgBufDesc : smiOCTETS* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wsnmp32")]
extern "system" {
    fn SnmpEncodeMsg(
        session: isize,  // INT_PTR
        srcEntity: isize,  // INT_PTR
        dstEntity: isize,  // INT_PTR
        context: isize,  // INT_PTR
        pdu: isize,  // INT_PTR
        msgBufDesc: *mut smiOCTETS  // smiOCTETS* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wsnmp32.dll")]
public static extern uint SnmpEncodeMsg(IntPtr session, IntPtr srcEntity, IntPtr dstEntity, IntPtr context, IntPtr pdu, IntPtr msgBufDesc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wsnmp32_SnmpEncodeMsg' -Namespace Win32 -PassThru
# $api::SnmpEncodeMsg(session, srcEntity, dstEntity, context, pdu, msgBufDesc)
#uselib "wsnmp32.dll"
#func global SnmpEncodeMsg "SnmpEncodeMsg" sptr, sptr, sptr, sptr, sptr, sptr
; SnmpEncodeMsg session, srcEntity, dstEntity, context, pdu, varptr(msgBufDesc)   ; 戻り値は stat
; session : INT_PTR -> "sptr"
; srcEntity : INT_PTR -> "sptr"
; dstEntity : INT_PTR -> "sptr"
; context : INT_PTR -> "sptr"
; pdu : INT_PTR -> "sptr"
; msgBufDesc : smiOCTETS* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "wsnmp32.dll"
#cfunc global SnmpEncodeMsg "SnmpEncodeMsg" sptr, sptr, sptr, sptr, sptr, var
; res = SnmpEncodeMsg(session, srcEntity, dstEntity, context, pdu, msgBufDesc)
; session : INT_PTR -> "sptr"
; srcEntity : INT_PTR -> "sptr"
; dstEntity : INT_PTR -> "sptr"
; context : INT_PTR -> "sptr"
; pdu : INT_PTR -> "sptr"
; msgBufDesc : smiOCTETS* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD SnmpEncodeMsg(INT_PTR session, INT_PTR srcEntity, INT_PTR dstEntity, INT_PTR context, INT_PTR pdu, smiOCTETS* msgBufDesc)
#uselib "wsnmp32.dll"
#cfunc global SnmpEncodeMsg "SnmpEncodeMsg" intptr, intptr, intptr, intptr, intptr, var
; res = SnmpEncodeMsg(session, srcEntity, dstEntity, context, pdu, msgBufDesc)
; session : INT_PTR -> "intptr"
; srcEntity : INT_PTR -> "intptr"
; dstEntity : INT_PTR -> "intptr"
; context : INT_PTR -> "intptr"
; pdu : INT_PTR -> "intptr"
; msgBufDesc : smiOCTETS* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsnmp32 = windows.NewLazySystemDLL("wsnmp32.dll")
	procSnmpEncodeMsg = wsnmp32.NewProc("SnmpEncodeMsg")
)

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