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使用するWinSNMPセッションハンドル。
srcEntityINT_PTRin送信元エンティティハンドル。
dstEntityINT_PTRin送信先エンティティハンドル。
contextINT_PTRin対象のコンテキストハンドル。
pduINT_PTRinエンコードするPDUハンドル。
msgBufDescsmiOCTETS*inoutエンコード済みメッセージを受け取るオクテット文字列(smiOCTETS)ポインタ。

戻り値の型: 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)。
const std = @import("std");

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

typedef SnmpEncodeMsgNative = Uint32 Function(IntPtr, IntPtr, IntPtr, IntPtr, IntPtr, Pointer<Void>);
typedef SnmpEncodeMsgDart = int Function(int, int, int, int, int, Pointer<Void>);
final SnmpEncodeMsg = DynamicLibrary.open('wsnmp32.dll')
    .lookupFunction<SnmpEncodeMsgNative, SnmpEncodeMsgDart>('SnmpEncodeMsg');
// session : INT_PTR -> IntPtr
// srcEntity : INT_PTR -> IntPtr
// dstEntity : INT_PTR -> IntPtr
// context : INT_PTR -> IntPtr
// pdu : INT_PTR -> IntPtr
// msgBufDesc : smiOCTETS* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SnmpEncodeMsg"
  c_SnmpEncodeMsg :: CIntPtr -> CIntPtr -> CIntPtr -> CIntPtr -> CIntPtr -> Ptr () -> IO Word32
-- session : INT_PTR -> CIntPtr
-- srcEntity : INT_PTR -> CIntPtr
-- dstEntity : INT_PTR -> CIntPtr
-- context : INT_PTR -> CIntPtr
-- pdu : INT_PTR -> CIntPtr
-- msgBufDesc : smiOCTETS* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let snmpencodemsg =
  foreign "SnmpEncodeMsg"
    (intptr_t @-> intptr_t @-> intptr_t @-> intptr_t @-> intptr_t @-> (ptr void) @-> 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 *)
(* msgBufDesc : smiOCTETS* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsnmp32 (t "wsnmp32.dll"))
(cffi:use-foreign-library wsnmp32)

(cffi:defcfun ("SnmpEncodeMsg" snmp-encode-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
  (msg-buf-desc :pointer))   ; smiOCTETS* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpEncodeMsg = Win32::API::More->new('wsnmp32',
    'DWORD SnmpEncodeMsg(LPARAM session, LPARAM srcEntity, LPARAM dstEntity, LPARAM context, LPARAM pdu, LPVOID msgBufDesc)');
# my $ret = $SnmpEncodeMsg->Call($session, $srcEntity, $dstEntity, $context, $pdu, $msgBufDesc);
# session : INT_PTR -> LPARAM
# srcEntity : INT_PTR -> LPARAM
# dstEntity : INT_PTR -> LPARAM
# context : INT_PTR -> LPARAM
# pdu : INT_PTR -> LPARAM
# msgBufDesc : smiOCTETS* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型