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

SnmpContextToStr

関数
WinSNMPコンテキストをオクテット文字列に変換する。
DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SnmpContextToStr(
    INT_PTR context,
    smiOCTETS* string
);

パラメーター

名前型方向説明
contextINT_PTRin対象となる SNMP コンテキストのハンドル。
stringsmiOCTETS*inout対象コンテキストを識別する文字列を受け取る smiOCTETS 構造体へのポインター。この文字列は、末尾に null 終端バイトを含むことがあります。

戻り値の型: DWORD

公式ドキュメント

WinSNMP の SnmpContextToStr 関数は、管理対象オブジェクトのリソースの集合である SNMP コンテキストを識別する文字列を返します。この関数は、その文字列を smiOCTETS 構造体に格納して返します。

戻り値

関数が成功した場合、戻り値は SNMPAPI_SUCCESS です。

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

戻り値 説明
SNMPAPI_NOT_INITIALIZED
SnmpStartup 関数が正常に完了していません。
SNMPAPI_ALLOC_ERROR
メモリの割り当て中にエラーが発生しました。
SNMPAPI_CONTEXT_INVALID
context パラメーターが無効です。
SNMPAPI_OTHER_ERROR
不明または未定義のエラーが発生しました。

解説(Remarks)

エンティティとコンテキストの変換モードの現在の設定によって、 SnmpContextToStr が返す出力文字列の種類が決まります。詳細については、 Setting the Entity and Context Translation Mode を参照してください。

WinSNMP アプリケーションは、string パラメーターに有効な smiOCTETS 構造体のアドレスを指定する必要があります。SnmpContextToStr 関数が正常に完了すると、Microsoft WinSNMP 実装はこの構造体の len メンバーと ptr メンバーを初期化します。WinSNMP アプリケーションは、 SnmpFreeDescriptor 関数を呼び出して、これらのメンバーのリソースを実装が解放できるようにする必要があります。

エンティティとコンテキストの変換モードが SNMPAPI_TRANSLATED であり、実装のデータベースにエントリが存在する場合、実装はそのコンテキストに関連付けられたわかりやすい名前を返します。コンテキスト名に対応するエントリが存在しない場合、 SnmpContextToStr は SNMP コミュニティ文字列を返します。

エンティティとコンテキストの変換モードが SNMPAPI_UNTRANSLATED_V1 または SNMPAPI_UNTRANSLATED_V2 の場合も、実装は SNMP コミュニティ文字列を返します。

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

各言語での呼び出し定義

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

DWORD SnmpContextToStr(
    INT_PTR context,
    smiOCTETS* string
);
[DllImport("wsnmp32.dll", ExactSpelling = true)]
static extern uint SnmpContextToStr(
    IntPtr context,   // INT_PTR
    IntPtr string   // smiOCTETS* in/out
);
<DllImport("wsnmp32.dll", ExactSpelling:=True)>
Public Shared Function SnmpContextToStr(
    context As IntPtr,   ' INT_PTR
    [string] As IntPtr   ' smiOCTETS* in/out
) As UInteger
End Function
' context : INT_PTR
' string : smiOCTETS* in/out
Declare PtrSafe Function SnmpContextToStr Lib "wsnmp32" ( _
    ByVal context As LongPtr, _
    ByVal string As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SnmpContextToStr = ctypes.windll.wsnmp32.SnmpContextToStr
SnmpContextToStr.restype = wintypes.DWORD
SnmpContextToStr.argtypes = [
    ctypes.c_ssize_t,  # context : INT_PTR
    ctypes.c_void_p,  # string : smiOCTETS* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	wsnmp32 = windows.NewLazySystemDLL("wsnmp32.dll")
	procSnmpContextToStr = wsnmp32.NewProc("SnmpContextToStr")
)

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

extern "wsnmp32" fn SnmpContextToStr(
    context: isize, // INT_PTR
    string: [*c]smiOCTETS // smiOCTETS* in/out
) callconv(std.os.windows.WINAPI) u32;
proc SnmpContextToStr(
    context: int,  # INT_PTR
    string: ptr smiOCTETS  # smiOCTETS* in/out
): uint32 {.importc: "SnmpContextToStr", stdcall, dynlib: "wsnmp32.dll".}
pragma(lib, "wsnmp32");
extern(Windows)
uint SnmpContextToStr(
    ptrdiff_t context,   // INT_PTR
    smiOCTETS* string   // smiOCTETS* in/out
);
ccall((:SnmpContextToStr, "wsnmp32.dll"), stdcall, UInt32,
      (Int, Ptr{smiOCTETS}),
      context, string)
# context : INT_PTR -> Int
# string : smiOCTETS* in/out -> Ptr{smiOCTETS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SnmpContextToStr(
    intptr_t context,
    void* string);
]]
local wsnmp32 = ffi.load("wsnmp32")
-- wsnmp32.SnmpContextToStr(context, string)
-- context : INT_PTR
-- string : smiOCTETS* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wsnmp32.dll');
const SnmpContextToStr = lib.func('__stdcall', 'SnmpContextToStr', 'uint32_t', ['intptr_t', 'void *']);
// SnmpContextToStr(context, string)
// context : INT_PTR -> 'intptr_t'
// string : smiOCTETS* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wsnmp32.dll", {
  SnmpContextToStr: { parameters: ["isize", "pointer"], result: "u32" },
});
// lib.symbols.SnmpContextToStr(context, string)
// context : INT_PTR -> "isize"
// string : smiOCTETS* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SnmpContextToStr(
    intptr_t context,
    void* string);
C, "wsnmp32.dll");
// $ffi->SnmpContextToStr(context, string);
// context : INT_PTR
// string : 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 SnmpContextToStr(
        long context,   // INT_PTR
        Pointer string   // smiOCTETS* in/out
    );
}
@[Link("wsnmp32")]
lib Libwsnmp32
  fun SnmpContextToStr = SnmpContextToStr(
    context : LibC::SSizeT,   # INT_PTR
    string : 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 SnmpContextToStrNative = Uint32 Function(IntPtr, Pointer<Void>);
typedef SnmpContextToStrDart = int Function(int, Pointer<Void>);
final SnmpContextToStr = DynamicLibrary.open('wsnmp32.dll')
    .lookupFunction<SnmpContextToStrNative, SnmpContextToStrDart>('SnmpContextToStr');
// context : INT_PTR -> IntPtr
// string : smiOCTETS* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SnmpContextToStr(
  context: NativeInt;   // INT_PTR
  string: Pointer   // smiOCTETS* in/out
): DWORD; stdcall;
  external 'wsnmp32.dll' name 'SnmpContextToStr';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let snmpcontexttostr =
  foreign "SnmpContextToStr"
    (intptr_t @-> (ptr void) @-> returning uint32_t)
(* context : INT_PTR -> intptr_t *)
(* string : 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 ("SnmpContextToStr" snmp-context-to-str :convention :stdcall) :uint32
  (context :int64)   ; INT_PTR
  (string :pointer))   ; smiOCTETS* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpContextToStr = Win32::API::More->new('wsnmp32',
    'DWORD SnmpContextToStr(LPARAM context, LPVOID string)');
# my $ret = $SnmpContextToStr->Call($context, $string);
# context : INT_PTR -> LPARAM
# string : smiOCTETS* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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