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

SnmpOidToStr

関数
WinSNMPのOIDをドット区切りの文字列に変換する。
DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SnmpOidToStr(
    smiOID* srcOID,
    DWORD size,
    LPSTR string
);

パラメーター

名前型方向説明
srcOIDsmiOID*in変換するオブジェクト識別子を保持する smiOID 構造体へのポインターです。
sizeDWORDinstring パラメーターで示されるバッファーのサイズをバイト単位で指定します。詳細については、後述の「解説」セクションを参照してください。
stringLPSTRoutSNMP 管理エンティティを指定する、変換された文字列形式のオブジェクト識別子を受け取るバッファーへのポインターです。

戻り値の型: DWORD

公式ドキュメント

WinSNMP の SnmpOidToStr 関数は、SNMP オブジェクト識別子の内部バイナリ表現を、ドット区切りの数値文字列形式(たとえば "1.2.3.4.5.6")に変換します。

戻り値

関数が成功した場合、戻り値は WinSNMP アプリケーションが string パラメーターに書き込んだ文字列の長さ(バイト単位)です。この戻り値には null 終端バイトが含まれます。この値は size パラメーターの値以下になりますが、それを超えることはありません。

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

戻り値 説明
SNMPAPI_NOT_INITIALIZED
SnmpStartup 関数が正常に完了していません。
SNMPAPI_ALLOC_ERROR
メモリの割り当て中にエラーが発生しました。
SNMPAPI_SIZE_INVALID
size パラメーターが無効です。このパラメーターを 0 にすることはできません。string パラメーターが指すバッファーのサイズを示す必要があります。
SNMPAPI_OID_INVALID
srcOID パラメーターが無効です。詳細については、後述の「解説」セクションを参照してください。
SNMPAPI_OUTPUT_TRUNCATED
出力バッファーの長さが不足しています。
SNMPAPI_OTHER_ERROR
不明または未定義のエラーが発生しました。

解説(Remarks)

WinSNMP アプリケーションでは、size パラメーターに MAXOBJIDSTRSIZE の長さ(1408 バイト)の文字列バッファーを指定することを推奨します。これにより、変換後の文字列を格納するのに十分な大きさの出力バッファーが確保されます。変換後の文字列は通常 MAXOBJIDSTRSIZE より短いため、WinSNMP アプリケーションは変換後の文字列をより小さなバッファーにコピーできます。その後、アプリケーションは最初のバッファー用に割り当てたメモリを再利用または解放できます。詳細については、 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 SnmpOidToStr(
    smiOID* srcOID,
    DWORD size,
    LPSTR string
);
[DllImport("wsnmp32.dll", ExactSpelling = true)]
static extern uint SnmpOidToStr(
    IntPtr srcOID,   // smiOID*
    uint size,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder string   // LPSTR out
);
<DllImport("wsnmp32.dll", ExactSpelling:=True)>
Public Shared Function SnmpOidToStr(
    srcOID As IntPtr,   ' smiOID*
    size As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> [string] As System.Text.StringBuilder   ' LPSTR out
) As UInteger
End Function
' srcOID : smiOID*
' size : DWORD
' string : LPSTR out
Declare PtrSafe Function SnmpOidToStr Lib "wsnmp32" ( _
    ByVal srcOID As LongPtr, _
    ByVal size As Long, _
    ByVal string As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SnmpOidToStr = ctypes.windll.wsnmp32.SnmpOidToStr
SnmpOidToStr.restype = wintypes.DWORD
SnmpOidToStr.argtypes = [
    ctypes.c_void_p,  # srcOID : smiOID*
    wintypes.DWORD,  # size : DWORD
    wintypes.LPSTR,  # string : LPSTR out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wsnmp32.dll')
SnmpOidToStr = Fiddle::Function.new(
  lib['SnmpOidToStr'],
  [
    Fiddle::TYPE_VOIDP,  # srcOID : smiOID*
    -Fiddle::TYPE_INT,  # size : DWORD
    Fiddle::TYPE_VOIDP,  # string : LPSTR out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wsnmp32")]
extern "system" {
    fn SnmpOidToStr(
        srcOID: *mut smiOID,  // smiOID*
        size: u32,  // DWORD
        string: *mut u8  // LPSTR out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wsnmp32.dll")]
public static extern uint SnmpOidToStr(IntPtr srcOID, uint size, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder string);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wsnmp32_SnmpOidToStr' -Namespace Win32 -PassThru
# $api::SnmpOidToStr(srcOID, size, string)
#uselib "wsnmp32.dll"
#func global SnmpOidToStr "SnmpOidToStr" sptr, sptr, sptr
; SnmpOidToStr varptr(srcOID), size, varptr(string)   ; 戻り値は stat
; srcOID : smiOID* -> "sptr"
; size : DWORD -> "sptr"
; string : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "wsnmp32.dll"
#cfunc global SnmpOidToStr "SnmpOidToStr" var, int, var
; res = SnmpOidToStr(srcOID, size, string)
; srcOID : smiOID* -> "var"
; size : DWORD -> "int"
; string : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD SnmpOidToStr(smiOID* srcOID, DWORD size, LPSTR string)
#uselib "wsnmp32.dll"
#cfunc global SnmpOidToStr "SnmpOidToStr" var, int, var
; res = SnmpOidToStr(srcOID, size, string)
; srcOID : smiOID* -> "var"
; size : DWORD -> "int"
; string : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsnmp32 = windows.NewLazySystemDLL("wsnmp32.dll")
	procSnmpOidToStr = wsnmp32.NewProc("SnmpOidToStr")
)

// srcOID (smiOID*), size (DWORD), string (LPSTR out)
r1, _, err := procSnmpOidToStr.Call(
	uintptr(srcOID),
	uintptr(size),
	uintptr(string),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SnmpOidToStr(
  srcOID: Pointer;   // smiOID*
  size: DWORD;   // DWORD
  string: PAnsiChar   // LPSTR out
): DWORD; stdcall;
  external 'wsnmp32.dll' name 'SnmpOidToStr';
result := DllCall("wsnmp32\SnmpOidToStr"
    , "Ptr", srcOID   ; smiOID*
    , "UInt", size   ; DWORD
    , "Ptr", string   ; LPSTR out
    , "UInt")   ; return: DWORD
●SnmpOidToStr(srcOID, size, string) = DLL("wsnmp32.dll", "dword SnmpOidToStr(void*, dword, char*)")
# 呼び出し: SnmpOidToStr(srcOID, size, string)
# srcOID : smiOID* -> "void*"
# size : DWORD -> "dword"
# string : LPSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SnmpOidToStrNative = Uint32 Function(Pointer<Void>, Uint32, Pointer<Utf8>);
typedef SnmpOidToStrDart = int Function(Pointer<Void>, int, Pointer<Utf8>);
final SnmpOidToStr = DynamicLibrary.open('wsnmp32.dll')
    .lookupFunction<SnmpOidToStrNative, SnmpOidToStrDart>('SnmpOidToStr');
// srcOID : smiOID* -> Pointer<Void>
// size : DWORD -> Uint32
// string : LPSTR out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SnmpOidToStr(
  srcOID: Pointer;   // smiOID*
  size: DWORD;   // DWORD
  string: PAnsiChar   // LPSTR out
): DWORD; stdcall;
  external 'wsnmp32.dll' name 'SnmpOidToStr';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SnmpOidToStr"
  c_SnmpOidToStr :: Ptr () -> Word32 -> CString -> IO Word32
-- srcOID : smiOID* -> Ptr ()
-- size : DWORD -> Word32
-- string : LPSTR out -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let snmpoidtostr =
  foreign "SnmpOidToStr"
    ((ptr void) @-> uint32_t @-> string @-> returning uint32_t)
(* srcOID : smiOID* -> (ptr void) *)
(* size : DWORD -> uint32_t *)
(* string : LPSTR out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsnmp32 (t "wsnmp32.dll"))
(cffi:use-foreign-library wsnmp32)

(cffi:defcfun ("SnmpOidToStr" snmp-oid-to-str :convention :stdcall) :uint32
  (src-oid :pointer)   ; smiOID*
  (size :uint32)   ; DWORD
  (string :pointer))   ; LPSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpOidToStr = Win32::API::More->new('wsnmp32',
    'DWORD SnmpOidToStr(LPVOID srcOID, DWORD size, LPSTR string)');
# my $ret = $SnmpOidToStr->Call($srcOID, $size, $string);
# srcOID : smiOID* -> LPVOID
# size : DWORD -> DWORD
# string : LPSTR out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型