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

smiVALUE

構造体
サイズx64: 24 バイト / x86: 12 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
syntaxDWORD4+0+0

value メンバーの構文データ型を示す符号なし長整数を指定します。このメンバーは、次の表に示す型のいずれか 1 つのみになります。詳細については、WinSNMP データ型および RFC 1902「Structure of Management Information for Version 2 of the Simple Network Management Protocol (SNMPv2)」を参照してください。

構文データ型 意味
SNMP_SYNTAX_INT
32 ビット符号付き整数の変数を示します。
SNMP_SYNTAX_OCTETS
バイナリ データまたはテキスト データであるオクテット文字列の変数を示します。
SNMP_SYNTAX_NULL
NULL 値を示します。
SNMP_SYNTAX_OID
最大 128 個のサブ識別子を持つ割り当て名であるオブジェクト識別子の変数を示します。
SNMP_SYNTAX_INT32
32 ビット符号付き整数の変数を示します。
SNMP_SYNTAX_IPADDR
32 ビットのインターネット アドレスの変数を示します。
SNMP_SYNTAX_CNTR32
最大値 (2^32) – 1 に達するまで増加するカウンター変数を示します。
SNMP_SYNTAX_GAUGE32
増加も減少もしますが、最大値を超えることはない非負整数であるゲージ変数を示します。
SNMP_SYNTAX_TIMETICKS
最大値 (2^32) – 1 に達するまで、時間を 100 分の 1 秒単位で計測するカウンター変数を示します。これは、特定のタイマー イベントを基準とする非負整数です。
SNMP_SYNTAX_OPAQUE
この型は下位互換性のために用意されており、新しいオブジェクト型には使用しないでください。任意の抽象構文記法 1 (ASN.1) 構文を渡す機能をサポートします。
SNMP_SYNTAX_CNTR64
最大値 (2^64) – 1 に達するまで増加するカウンター変数を示します。
SNMP_SYNTAX_UINT32
32 ビット符号なし整数の変数を示します。
SNMP_SYNTAX_NOSUCHOBJECT
変数に対応するオブジェクト型をエージェントがサポートしていないことを示します。
SNMP_SYNTAX_NOSUCHINSTANCE
操作の対象となるオブジェクト インスタンスが存在しないことを示します。
SNMP_SYNTAX_ENDOFMIBVIEW
WinSNMP アプリケーションが、エージェントのサポートする MIB ツリーの末尾を超えたオブジェクト識別子を参照しようとしていることを示します。

最後の 3 つの構文型は、SNMP バージョン 2C (SNMPv2C) フレームワークにおける例外状態を表します。

value_value_e__Union16/8+8+4

smiOID 記述子型や smiOCTETS 記述子型を含む、すべての可能な WinSNMP 構文データ型の共用体を指定します。

sNumber

Type: smiINT

符号付き長整数値を指定します。

uNumber

Type: smiUINT32

32 ビットの符号なし長整数値を指定します。

hNumber

Type: smiCNTR64

64 ビットの符号なし整数値を指定します。

string

Type: smiOCTETS

文字列を指定します。

oid

Type: smiOID

オブジェクト識別子 (OID) を指定します。

empty

Type: smiBYTE

空のメンバーを指定します。

共用体: _value_e__Union x64 16B / x86 8B

フィールド型サイズx64x86
sNumberINT4+0+0
uNumberDWORD4+0+0
hNumbersmiCNTR648+0+0
stringsmiOCTETS16/8+0+0
oidsmiOID16/8+0+0
emptyBYTE1+0+0

公式ドキュメント

[SNMP は、「要件」セクションに記載されているオペレーティング システムで使用できます。以降のバージョンでは、変更されるか、利用できなくなる可能性があります。代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用してください。]

WinSNMP の smiVALUE 構造体は、変数バインディング エントリ内の変数名に関連付けられた値を記述します。

smiVALUE 構造体の syntax メンバーには、value メンバー内のデータの型を示す WinSNMP データ型が格納されます。この構造体の value メンバーは、すべての可能な WinSNMP データ型の共用体です。

解説(Remarks)

WinSNMP アプリケーションは、value メンバーを正しく逆参照するために、smiVALUE 構造体の syntax メンバーを確認する必要があります。value メンバーには、単純なスカラー値のほか、smiOCTETS や smiOID の記述子構造体のような非スカラー値が格納されることがあります。

syntax メンバーによって、value メンバーが smiOCTETS または smiOID の記述子構造体であることが示されている場合、WinSNMP アプリケーションは、その構造体に割り当てられたリソースを解放するかどうかを判断する必要があります。Microsoft の WinSNMP 実装は、すべての出力用 smiOCTETS 構造体および smiOID 構造体について、メモリの割り当てと解放を行います。アプリケーションは、これらの構造体の ptr メンバーのメモリを解放するために、SnmpFreeDescriptor 関数を呼び出す必要があります。

可変長の入力記述子のメモリは WinSNMP アプリケーションが割り当てるため、そのメモリはアプリケーションが解放しなければなりません。詳細については、WinSNMP データ管理の概念を参照してください。

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

各言語での定義

#include <windows.h>

// smiVALUE  (x64 24 / x86 12 バイト)
typedef struct smiVALUE {
    DWORD syntax;
    _value_e__Union value;
} smiVALUE;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct smiVALUE
{
    public uint syntax;
    public _value_e__Union value;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure smiVALUE
    Public syntax As UInteger
    Public value As _value_e__Union
End Structure
import ctypes
from ctypes import wintypes

class smiVALUE(ctypes.Structure):
    _fields_ = [
        ("syntax", wintypes.DWORD),
        ("value", _value_e__Union),
    ]
#[repr(C)]
pub struct smiVALUE {
    pub syntax: u32,
    pub value: _value_e__Union,
}
import "golang.org/x/sys/windows"

type smiVALUE struct {
	syntax uint32
	value _value_e__Union
}
type
  smiVALUE = record
    syntax: DWORD;
    value: _value_e__Union;
  end;
const smiVALUE = extern struct {
    syntax: u32,
    value: _value_e__Union,
};
type
  smiVALUE {.bycopy.} = object
    syntax: uint32
    value: _value_e__Union
struct smiVALUE
{
    uint syntax;
    _value_e__Union value;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; smiVALUE サイズ: 12 バイト(x86)
dim st, 3    ; 4byte整数×3(構造体サイズ 12 / 4 切り上げ)
; syntax : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; value : _value_e__Union (+4, 8byte)  varptr(st)+4 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; smiVALUE サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; syntax : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; value : _value_e__Union (+8, 16byte)  varptr(st)+8 を基点に操作(16byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global smiVALUE
    #field int syntax
    #field byte value 16
#endstruct

stdim st, smiVALUE        ; NSTRUCT 変数を確保
st->syntax = 100
mes "syntax=" + st->syntax
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。