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

RegisterHelper

関数
netshに親コンテキスト用のヘルパーを登録する。
DLLNETSH.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD RegisterHelper(
    const GUID* pguidParentContext,
    const NS_HELPER_ATTRIBUTES* pfnRegisterSubContext
);

パラメーター

名前方向説明
pguidParentContextGUID*in親コンテキストを識別するGUIDへのポインター。
pfnRegisterSubContextNS_HELPER_ATTRIBUTES*inサブコンテキスト登録関数を含むNS_HELPER_ATTRIBUTES構造体へのポインター。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD RegisterHelper(
    const GUID* pguidParentContext,
    const NS_HELPER_ATTRIBUTES* pfnRegisterSubContext
);
[DllImport("NETSH.dll", ExactSpelling = true)]
static extern uint RegisterHelper(
    ref Guid pguidParentContext,   // GUID*
    IntPtr pfnRegisterSubContext   // NS_HELPER_ATTRIBUTES*
);
<DllImport("NETSH.dll", ExactSpelling:=True)>
Public Shared Function RegisterHelper(
    ByRef pguidParentContext As Guid,   ' GUID*
    pfnRegisterSubContext As IntPtr   ' NS_HELPER_ATTRIBUTES*
) As UInteger
End Function
' pguidParentContext : GUID*
' pfnRegisterSubContext : NS_HELPER_ATTRIBUTES*
Declare PtrSafe Function RegisterHelper Lib "netsh" ( _
    ByVal pguidParentContext As LongPtr, _
    ByVal pfnRegisterSubContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegisterHelper = ctypes.windll.netsh.RegisterHelper
RegisterHelper.restype = wintypes.DWORD
RegisterHelper.argtypes = [
    ctypes.c_void_p,  # pguidParentContext : GUID*
    ctypes.c_void_p,  # pfnRegisterSubContext : NS_HELPER_ATTRIBUTES*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	netsh = windows.NewLazySystemDLL("NETSH.dll")
	procRegisterHelper = netsh.NewProc("RegisterHelper")
)

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

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

typedef RegisterHelperNative = Uint32 Function(Pointer<Void>, Pointer<Void>);
typedef RegisterHelperDart = int Function(Pointer<Void>, Pointer<Void>);
final RegisterHelper = DynamicLibrary.open('NETSH.dll')
    .lookupFunction<RegisterHelperNative, RegisterHelperDart>('RegisterHelper');
// pguidParentContext : GUID* -> Pointer<Void>
// pfnRegisterSubContext : NS_HELPER_ATTRIBUTES* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegisterHelper(
  pguidParentContext: PGUID;   // GUID*
  pfnRegisterSubContext: Pointer   // NS_HELPER_ATTRIBUTES*
): DWORD; stdcall;
  external 'NETSH.dll' name 'RegisterHelper';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegisterHelper"
  c_RegisterHelper :: Ptr () -> Ptr () -> IO Word32
-- pguidParentContext : GUID* -> Ptr ()
-- pfnRegisterSubContext : NS_HELPER_ATTRIBUTES* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let registerhelper =
  foreign "RegisterHelper"
    ((ptr void) @-> (ptr void) @-> returning uint32_t)
(* pguidParentContext : GUID* -> (ptr void) *)
(* pfnRegisterSubContext : NS_HELPER_ATTRIBUTES* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netsh (t "NETSH.dll"))
(cffi:use-foreign-library netsh)

(cffi:defcfun ("RegisterHelper" register-helper :convention :stdcall) :uint32
  (pguid-parent-context :pointer)   ; GUID*
  (pfn-register-sub-context :pointer))   ; NS_HELPER_ATTRIBUTES*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegisterHelper = Win32::API::More->new('NETSH',
    'DWORD RegisterHelper(LPVOID pguidParentContext, LPVOID pfnRegisterSubContext)');
# my $ret = $RegisterHelper->Call($pguidParentContext, $pfnRegisterSubContext);
# pguidParentContext : GUID* -> LPVOID
# pfnRegisterSubContext : NS_HELPER_ATTRIBUTES* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型