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

SnmpSetPort

関数
指定したエンティティが使用する通信ポート番号を設定する。
DLLwsnmp32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SnmpSetPort(
    INT_PTR hEntity,
    DWORD nPort
);

パラメーター

名前型方向説明
hEntityINT_PTRinWinSNMP の宛先エンティティへのハンドル。このパラメーターには、 SnmpListen 関数の呼び出しの結果として SNMP エージェントアプリケーションの役割で動作しているエンティティのハンドルを指定できます。詳細については、後述の「解説」セクションを参照してください。
nPortDWORDin宛先エンティティの新しいポート割り当てを識別する符号なし整数を指定します。使用中のローカルアドレスを指定した場合、または利用できないリモートアドレスを指定した場合、 SnmpSetPort 関数の呼び出しは失敗します。

戻り値の型: DWORD

公式ドキュメント

WinSNMP アプリケーションは、宛先エンティティに割り当てられているポートを変更するために SnmpSetPort 関数を呼び出します。SnmpSetPort 関数は WinSNMP API バージョン 2.0 の要素です。

戻り値

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

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

戻り値 説明
SNMPAPI_NOT_INITIALIZED

SnmpStartup 関数が正常に完了しませんでした。

SNMPAPI_OPERATION_INVALID
hEntity パラメーターで指定されたエンティティは、 SnmpListen 関数の呼び出しの結果として、既にエージェントの役割で機能しています。詳細については、後述の「解説」セクションを参照してください。
SNMPAPI_ENTITY_INVALID
hEntity パラメーターが無効です。このパラメーターには、事前の SnmpStrToEntity 関数の呼び出しによって返されたハンドルを指定する必要があります。
SNMPAPI_OTHER_ERROR
不明または未定義のエラーが発生しました。

解説(Remarks)

Microsoft の WinSNMP 実装は、WinSNMP アプリケーションによる SnmpStrToEntity 関数の呼び出しの結果として、各管理エンティティにポートを割り当てます。実装がエンティティを作成する時点で SNMPAPI_UNTRANSLATED モードが有効な場合、実装は通常、該当するプロトコルファミリーの標準的な SNMP 要求ポート (たとえば UDP 161 や IPX 36879) をエンティティに割り当てます。SNMPAPI_TRANSLATED モードが有効な場合、実装は WinSNMP データベースでそのエンティティに指定されているポートを割り当てます。実装で現在有効なエンティティおよびコンテキストの変換モードを取得するには、アプリケーションから SnmpGetTranslateMode 関数を呼び出します。詳細については、 Setting the Entity and Context Translation Mode および The WinSNMP Database を参照してください。

hEntity パラメーターで指定されたエンティティが現在エージェントの役割で機能している場合、 SnmpSetPort 関数の呼び出しは失敗します。これは、そのエンティティが nPort パラメーターで指定されたポート以外のポートに既に割り当てられているためです。エージェントアプリケーションを特定のポートに確実に割り当てるには、WinSNMP アプリケーションで次の手順を実行します。

  1. 次のように SnmpStrToEntity を呼び出します。

    hAgent = SnmpStrToEntity (hSession, <addrString>);

  2. 次のように SnmpSetPort を呼び出します。

    SnmpSetPort (hAgent, <nPort>);

  3. 次のように SnmpListen を呼び出します。

    SnmpListen (hAgent, SNMPAPI_ON);

ここで、<addrString> には IP アドレスまたは IPX アドレスの文字列表現が含まれ、<nPort> にはエージェントアプリケーションの新しいポート割り当てが含まれます。

IPX アドレスは、8 桁の 16 進数から成るネットワーク番号 (必要に応じてゼロ埋め)、区切り文字 (":"、"."、" – " のいずれか)、および 12 桁の 16 進数から成るノード番号 (必要に応じてゼロ埋め) で構成される点に注意してください。たとえば 00000001:00081A0D01C2 のようになります。詳細については、 Support for IPX Address Strings in WinSNMP を参照してください。

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

各言語での呼び出し定義

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

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

SnmpSetPort = ctypes.windll.wsnmp32.SnmpSetPort
SnmpSetPort.restype = wintypes.DWORD
SnmpSetPort.argtypes = [
    ctypes.c_ssize_t,  # hEntity : INT_PTR
    wintypes.DWORD,  # nPort : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wsnmp32.dll')
SnmpSetPort = Fiddle::Function.new(
  lib['SnmpSetPort'],
  [
    Fiddle::TYPE_INTPTR_T,  # hEntity : INT_PTR
    -Fiddle::TYPE_INT,  # nPort : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wsnmp32")]
extern "system" {
    fn SnmpSetPort(
        hEntity: isize,  // INT_PTR
        nPort: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wsnmp32.dll")]
public static extern uint SnmpSetPort(IntPtr hEntity, uint nPort);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wsnmp32_SnmpSetPort' -Namespace Win32 -PassThru
# $api::SnmpSetPort(hEntity, nPort)
#uselib "wsnmp32.dll"
#func global SnmpSetPort "SnmpSetPort" sptr, sptr
; SnmpSetPort hEntity, nPort   ; 戻り値は stat
; hEntity : INT_PTR -> "sptr"
; nPort : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "wsnmp32.dll"
#cfunc global SnmpSetPort "SnmpSetPort" sptr, int
; res = SnmpSetPort(hEntity, nPort)
; hEntity : INT_PTR -> "sptr"
; nPort : DWORD -> "int"
; DWORD SnmpSetPort(INT_PTR hEntity, DWORD nPort)
#uselib "wsnmp32.dll"
#cfunc global SnmpSetPort "SnmpSetPort" intptr, int
; res = SnmpSetPort(hEntity, nPort)
; hEntity : INT_PTR -> "intptr"
; nPort : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wsnmp32 = windows.NewLazySystemDLL("wsnmp32.dll")
	procSnmpSetPort = wsnmp32.NewProc("SnmpSetPort")
)

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

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

typedef SnmpSetPortNative = Uint32 Function(IntPtr, Uint32);
typedef SnmpSetPortDart = int Function(int, int);
final SnmpSetPort = DynamicLibrary.open('wsnmp32.dll')
    .lookupFunction<SnmpSetPortNative, SnmpSetPortDart>('SnmpSetPort');
// hEntity : INT_PTR -> IntPtr
// nPort : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SnmpSetPort(
  hEntity: NativeInt;   // INT_PTR
  nPort: DWORD   // DWORD
): DWORD; stdcall;
  external 'wsnmp32.dll' name 'SnmpSetPort';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SnmpSetPort"
  c_SnmpSetPort :: CIntPtr -> Word32 -> IO Word32
-- hEntity : INT_PTR -> CIntPtr
-- nPort : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let snmpsetport =
  foreign "SnmpSetPort"
    (intptr_t @-> uint32_t @-> returning uint32_t)
(* hEntity : INT_PTR -> intptr_t *)
(* nPort : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wsnmp32 (t "wsnmp32.dll"))
(cffi:use-foreign-library wsnmp32)

(cffi:defcfun ("SnmpSetPort" snmp-set-port :convention :stdcall) :uint32
  (h-entity :int64)   ; INT_PTR
  (n-port :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SnmpSetPort = Win32::API::More->new('wsnmp32',
    'DWORD SnmpSetPort(LPARAM hEntity, DWORD nPort)');
# my $ret = $SnmpSetPort->Call($hEntity, $nPort);
# hEntity : INT_PTR -> LPARAM
# nPort : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目