ホーム › NetworkManagement.Snmp › SnmpDecodeMsg

SnmpDecodeMsg

関数

受信バイト列をデコードしWinSNMPメッセージに復元する。

DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

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

パラメーター

名前	型	方向	説明
session	INT_PTR	in	WinSNMP セッションのハンドル。このパラメーターは必須です。詳細については、後述の「解説」セクションを参照してください。
srcEntity	INT_PTR*	inout	送信元の管理エンティティのハンドルを受け取る変数へのポインター。詳細については、後述の「解説」セクションを参照してください。
dstEntity	INT_PTR*	inout	対象の管理エンティティのハンドルを受け取る変数へのポインター。詳細については、後述の「解説」セクションを参照してください。
context	INT_PTR*	inout	対象の管理エンティティが制御するコンテキスト (管理対象オブジェクトのリソースの集合) のハンドルを受け取る変数へのポインター。
pdu	INT_PTR*	inout	SNMP プロトコルデータユニット (PDU) のハンドルを受け取る変数へのポインター。
msgBufDesc	smiOCTETS*	inout	デコードして構成要素に分解する SNMP メッセージを格納した smiOCTETS 構造体へのポインター。構造体の len メンバーは処理する最大バイト数を指定し、ptr メンバーはエンコードされた SNMP メッセージを指します。

戻り値の型: DWORD

公式ドキュメント

WinSNMP の SnmpDecodeMsg 関数は、エンコードされた SNMP メッセージをデコードして各構成要素に分解します。この関数は、WinSNMP の SnmpEncodeMsg 関数とは逆の動作を行います。

戻り値

関数が成功した場合、戻り値はデコードされたバイト数です。この値は、msgBufDesc パラメーターが指す smiOCTETS 構造体の len メンバーと等しいか、それより小さくなります。

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

戻り値	説明
SNMPAPI_NOT_INITIALIZED	SnmpStartup 関数が正常に完了しませんでした。
SNMPAPI_ALLOC_ERROR	メモリの割り当て中にエラーが発生しました。
SNMPAPI_SESSION_INVALID	session パラメーターが無効です。
SNMPAPI_ENTITY_INVALID	エンティティを指定するパラメーターの一方または両方が無効です。
SNMPAPI_CONTEXT_INVALID	context パラメーターが無効です。
SNMPAPI_PDU_INVALID	pdu パラメーターが無効です。
SNMPAPI_OUTPUT_TRUNCATED	出力バッファーの長さが不足しています。出力パラメーターは作成されませんでした。
SNMPAPI_MESSAGE_INVALID	msgBufDesc パラメーターで示されるバッファー内の SNMP メッセージの形式が無効です。出力パラメーターは作成されませんでした。
SNMPAPI_OTHER_ERROR	不明または未定義のエラーが発生しました。

解説(Remarks)

アプリケーションが SNMPv1 または SNMPv2C のメッセージを SnmpDecodeMsg 関数に渡した場合、Microsoft WinSNMP 実装は srcEntity パラメーターと dstEntity パラメーターにゼロを返します。これは、そのメッセージ形式には WinSNMP のエンティティリソースを作成するために必要なアドレス情報が含まれていないためです。

Microsoft WinSNMP 実装は、 SnmpDecodeMsg 関数の呼び出しが成功した結果として、WinSNMP アプリケーションにリソースを割り当てます。WinSNMP アプリケーションでは、各リソースに対応する WinSNMP 関数を使用して個々のリソースを解放することをお勧めします。詳細については、 Freeing WinSNMP Descriptors および WinSNMP Data Management Concepts を参照してください。

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

各言語での呼び出し定義

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

DWORD SnmpDecodeMsg(
    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 SnmpDecodeMsg(
    IntPtr session,   // INT_PTR
    ref IntPtr srcEntity,   // INT_PTR* in/out
    ref IntPtr dstEntity,   // INT_PTR* in/out
    ref IntPtr context,   // INT_PTR* in/out
    ref IntPtr pdu,   // INT_PTR* in/out
    IntPtr msgBufDesc   // smiOCTETS* in/out
);

<DllImport("wsnmp32.dll", ExactSpelling:=True)>
Public Shared Function SnmpDecodeMsg(
    session As IntPtr,   ' INT_PTR
    ByRef srcEntity As IntPtr,   ' INT_PTR* in/out
    ByRef dstEntity As IntPtr,   ' INT_PTR* in/out
    ByRef context As IntPtr,   ' INT_PTR* in/out
    ByRef pdu As IntPtr,   ' INT_PTR* in/out
    msgBufDesc As IntPtr   ' smiOCTETS* in/out
) As UInteger
End Function

' session : INT_PTR
' srcEntity : INT_PTR* in/out
' dstEntity : INT_PTR* in/out
' context : INT_PTR* in/out
' pdu : INT_PTR* in/out
' msgBufDesc : smiOCTETS* in/out
Declare PtrSafe Function SnmpDecodeMsg Lib "wsnmp32" ( _
    ByVal session As LongPtr, _
    ByRef srcEntity As LongPtr, _
    ByRef dstEntity As LongPtr, _
    ByRef context As LongPtr, _
    ByRef 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

SnmpDecodeMsg = ctypes.windll.wsnmp32.SnmpDecodeMsg
SnmpDecodeMsg.restype = wintypes.DWORD
SnmpDecodeMsg.argtypes = [
    ctypes.c_ssize_t,  # session : INT_PTR
    ctypes.POINTER(ctypes.c_ssize_t),  # srcEntity : INT_PTR* in/out
    ctypes.POINTER(ctypes.c_ssize_t),  # dstEntity : INT_PTR* in/out
    ctypes.POINTER(ctypes.c_ssize_t),  # context : INT_PTR* in/out
    ctypes.POINTER(ctypes.c_ssize_t),  # pdu : INT_PTR* in/out
    ctypes.c_void_p,  # msgBufDesc : smiOCTETS* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wsnmp32.dll')
SnmpDecodeMsg = Fiddle::Function.new(
  lib['SnmpDecodeMsg'],
  [
    Fiddle::TYPE_INTPTR_T,  # session : INT_PTR
    Fiddle::TYPE_VOIDP,  # srcEntity : INT_PTR* in/out
    Fiddle::TYPE_VOIDP,  # dstEntity : INT_PTR* in/out
    Fiddle::TYPE_VOIDP,  # context : INT_PTR* in/out
    Fiddle::TYPE_VOIDP,  # pdu : INT_PTR* in/out
    Fiddle::TYPE_VOIDP,  # msgBufDesc : smiOCTETS* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wsnmp32")]
extern "system" {
    fn SnmpDecodeMsg(
        session: isize,  // INT_PTR
        srcEntity: *mut isize,  // INT_PTR* in/out
        dstEntity: *mut isize,  // INT_PTR* in/out
        context: *mut isize,  // INT_PTR* in/out
        pdu: *mut isize,  // INT_PTR* in/out
        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 SnmpDecodeMsg(IntPtr session, ref IntPtr srcEntity, ref IntPtr dstEntity, ref IntPtr context, ref IntPtr pdu, IntPtr msgBufDesc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wsnmp32_SnmpDecodeMsg' -Namespace Win32 -PassThru
# $api::SnmpDecodeMsg(session, srcEntity, dstEntity, context, pdu, msgBufDesc)

#uselib "wsnmp32.dll"
#func global SnmpDecodeMsg "SnmpDecodeMsg" sptr, sptr, sptr, sptr, sptr, sptr
; SnmpDecodeMsg session, varptr(srcEntity), varptr(dstEntity), varptr(context), varptr(pdu), varptr(msgBufDesc)   ; 戻り値は stat
; session : INT_PTR -> "sptr"
; srcEntity : INT_PTR* in/out -> "sptr"
; dstEntity : INT_PTR* in/out -> "sptr"
; context : INT_PTR* in/out -> "sptr"
; pdu : INT_PTR* in/out -> "sptr"
; msgBufDesc : smiOCTETS* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wsnmp32.dll"
#cfunc global SnmpDecodeMsg "SnmpDecodeMsg" sptr, var, var, var, var, var
; res = SnmpDecodeMsg(session, srcEntity, dstEntity, context, pdu, msgBufDesc)
; session : INT_PTR -> "sptr"
; srcEntity : INT_PTR* in/out -> "var"
; dstEntity : INT_PTR* in/out -> "var"
; context : INT_PTR* in/out -> "var"
; pdu : INT_PTR* in/out -> "var"
; msgBufDesc : smiOCTETS* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wsnmp32.dll"
#cfunc global SnmpDecodeMsg "SnmpDecodeMsg" sptr, sptr, sptr, sptr, sptr, sptr
; res = SnmpDecodeMsg(session, varptr(srcEntity), varptr(dstEntity), varptr(context), varptr(pdu), varptr(msgBufDesc))
; session : INT_PTR -> "sptr"
; srcEntity : INT_PTR* in/out -> "sptr"
; dstEntity : INT_PTR* in/out -> "sptr"
; context : INT_PTR* in/out -> "sptr"
; pdu : INT_PTR* in/out -> "sptr"
; msgBufDesc : smiOCTETS* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。