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

smiOCTETS

構造体
サイズx64: 16 バイト / x86: 8 バイト

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

フィールド

フィールドサイズx64x86説明
lenDWORD4+0+0ptr メンバーが指すオクテット文字列配列のバイト数を示す符号なし長整数値を指定します。
ptrBYTE*8/4+8+4対象のオクテット文字列を格納するバイト配列へのポインターです。終端の NULL バイトは必要ありません。

公式ドキュメント

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

WinSNMP の smiOCTETS 構造体は、複数の WinSNMP 関数にコンテキスト文字列を渡します。この構造体は、エンコードされた SNMP メッセージの記述と受け取りにも使用されます。

smiOCTETS 構造体には、可変長の SNMP オクテット文字列へのポインターが含まれます。この構造体は、smiVALUE 構造体のメンバーになることがあります。

解説(Remarks)

Microsoft の WinSNMP 実装は、すべての出力用 smiOCTETS 構造体のメモリの割り当てと解放を行います。WinSNMP アプリケーションは、実装が smiOCTETS 構造体の 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>

// smiOCTETS  (x64 16 / x86 8 バイト)
typedef struct smiOCTETS {
    DWORD len;
    BYTE* ptr;
} smiOCTETS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct smiOCTETS
{
    public uint len;
    public IntPtr ptr;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure smiOCTETS
    Public len As UInteger
    Public ptr As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class smiOCTETS(ctypes.Structure):
    _fields_ = [
        ("len", wintypes.DWORD),
        ("ptr", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct smiOCTETS {
    pub len: u32,
    pub ptr: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type smiOCTETS struct {
	len uint32
	ptr uintptr
}
type
  smiOCTETS = record
    len: DWORD;
    ptr: Pointer;
  end;
const smiOCTETS = extern struct {
    len: u32,
    ptr: ?*anyopaque,
};
type
  smiOCTETS {.bycopy.} = object
    len: uint32
    ptr: pointer
struct smiOCTETS
{
    uint len;
    void* ptr;
}

HSP用 定義

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

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

stdim st, smiOCTETS        ; NSTRUCT 変数を確保
st->len = 100
mes "len=" + st->len