Win32 API 日本語リファレンス
ホームSystem.HostComputeNetwork › HcnEnumerateEndpoints

HcnEnumerateEndpoints

関数
クエリに一致するネットワークエンドポイントを列挙する。
DLLcomputenetwork.dll呼出規約winapi

シグネチャ

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

HRESULT HcnEnumerateEndpoints(
    LPCWSTR Query,
    LPWSTR* Endpoints,
    LPWSTR* ErrorRecord   // optional
);

パラメーター

名前方向説明
QueryLPCWSTRin列挙対象を絞り込むJSON形式のクエリ文字列。NULL可で全エンドポイントを列挙する。
EndpointsLPWSTR*out該当エンドポイントのIDをJSON配列で受け取る文字列ポインタ。解放が必要である。
ErrorRecordLPWSTR*outoptional失敗時のエラー詳細をJSONで受け取る文字列ポインタ。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT HcnEnumerateEndpoints(
    LPCWSTR Query,
    LPWSTR* Endpoints,
    LPWSTR* ErrorRecord   // optional
);
[DllImport("computenetwork.dll", ExactSpelling = true)]
static extern int HcnEnumerateEndpoints(
    [MarshalAs(UnmanagedType.LPWStr)] string Query,   // LPCWSTR
    IntPtr Endpoints,   // LPWSTR* out
    IntPtr ErrorRecord   // LPWSTR* optional, out
);
<DllImport("computenetwork.dll", ExactSpelling:=True)>
Public Shared Function HcnEnumerateEndpoints(
    <MarshalAs(UnmanagedType.LPWStr)> Query As String,   ' LPCWSTR
    Endpoints As IntPtr,   ' LPWSTR* out
    ErrorRecord As IntPtr   ' LPWSTR* optional, out
) As Integer
End Function
' Query : LPCWSTR
' Endpoints : LPWSTR* out
' ErrorRecord : LPWSTR* optional, out
Declare PtrSafe Function HcnEnumerateEndpoints Lib "computenetwork" ( _
    ByVal Query As LongPtr, _
    ByVal Endpoints As LongPtr, _
    ByVal ErrorRecord As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

HcnEnumerateEndpoints = ctypes.windll.computenetwork.HcnEnumerateEndpoints
HcnEnumerateEndpoints.restype = ctypes.c_int
HcnEnumerateEndpoints.argtypes = [
    wintypes.LPCWSTR,  # Query : LPCWSTR
    ctypes.c_void_p,  # Endpoints : LPWSTR* out
    ctypes.c_void_p,  # ErrorRecord : LPWSTR* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('computenetwork.dll')
HcnEnumerateEndpoints = Fiddle::Function.new(
  lib['HcnEnumerateEndpoints'],
  [
    Fiddle::TYPE_VOIDP,  # Query : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Endpoints : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # ErrorRecord : LPWSTR* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "computenetwork")]
extern "system" {
    fn HcnEnumerateEndpoints(
        Query: *const u16,  // LPCWSTR
        Endpoints: *mut *mut u16,  // LPWSTR* out
        ErrorRecord: *mut *mut u16  // LPWSTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("computenetwork.dll")]
public static extern int HcnEnumerateEndpoints([MarshalAs(UnmanagedType.LPWStr)] string Query, IntPtr Endpoints, IntPtr ErrorRecord);
"@
$api = Add-Type -MemberDefinition $sig -Name 'computenetwork_HcnEnumerateEndpoints' -Namespace Win32 -PassThru
# $api::HcnEnumerateEndpoints(Query, Endpoints, ErrorRecord)
#uselib "computenetwork.dll"
#func global HcnEnumerateEndpoints "HcnEnumerateEndpoints" sptr, sptr, sptr
; HcnEnumerateEndpoints Query, varptr(Endpoints), varptr(ErrorRecord)   ; 戻り値は stat
; Query : LPCWSTR -> "sptr"
; Endpoints : LPWSTR* out -> "sptr"
; ErrorRecord : LPWSTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "computenetwork.dll"
#cfunc global HcnEnumerateEndpoints "HcnEnumerateEndpoints" wstr, var, var
; res = HcnEnumerateEndpoints(Query, Endpoints, ErrorRecord)
; Query : LPCWSTR -> "wstr"
; Endpoints : LPWSTR* out -> "var"
; ErrorRecord : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT HcnEnumerateEndpoints(LPCWSTR Query, LPWSTR* Endpoints, LPWSTR* ErrorRecord)
#uselib "computenetwork.dll"
#cfunc global HcnEnumerateEndpoints "HcnEnumerateEndpoints" wstr, var, var
; res = HcnEnumerateEndpoints(Query, Endpoints, ErrorRecord)
; Query : LPCWSTR -> "wstr"
; Endpoints : LPWSTR* out -> "var"
; ErrorRecord : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	computenetwork = windows.NewLazySystemDLL("computenetwork.dll")
	procHcnEnumerateEndpoints = computenetwork.NewProc("HcnEnumerateEndpoints")
)

// Query (LPCWSTR), Endpoints (LPWSTR* out), ErrorRecord (LPWSTR* optional, out)
r1, _, err := procHcnEnumerateEndpoints.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Query))),
	uintptr(Endpoints),
	uintptr(ErrorRecord),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function HcnEnumerateEndpoints(
  Query: PWideChar;   // LPCWSTR
  Endpoints: PPWideChar;   // LPWSTR* out
  ErrorRecord: PPWideChar   // LPWSTR* optional, out
): Integer; stdcall;
  external 'computenetwork.dll' name 'HcnEnumerateEndpoints';
result := DllCall("computenetwork\HcnEnumerateEndpoints"
    , "WStr", Query   ; LPCWSTR
    , "Ptr", Endpoints   ; LPWSTR* out
    , "Ptr", ErrorRecord   ; LPWSTR* optional, out
    , "Int")   ; return: HRESULT
●HcnEnumerateEndpoints(Query, Endpoints, ErrorRecord) = DLL("computenetwork.dll", "int HcnEnumerateEndpoints(char*, void*, void*)")
# 呼び出し: HcnEnumerateEndpoints(Query, Endpoints, ErrorRecord)
# Query : LPCWSTR -> "char*"
# Endpoints : LPWSTR* out -> "void*"
# ErrorRecord : LPWSTR* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef HcnEnumerateEndpointsNative = Int32 Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>);
typedef HcnEnumerateEndpointsDart = int Function(Pointer<Utf16>, Pointer<Pointer<Utf16>>, Pointer<Pointer<Utf16>>);
final HcnEnumerateEndpoints = DynamicLibrary.open('computenetwork.dll')
    .lookupFunction<HcnEnumerateEndpointsNative, HcnEnumerateEndpointsDart>('HcnEnumerateEndpoints');
// Query : LPCWSTR -> Pointer<Utf16>
// Endpoints : LPWSTR* out -> Pointer<Pointer<Utf16>>
// ErrorRecord : LPWSTR* optional, out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function HcnEnumerateEndpoints(
  Query: PWideChar;   // LPCWSTR
  Endpoints: PPWideChar;   // LPWSTR* out
  ErrorRecord: PPWideChar   // LPWSTR* optional, out
): Integer; stdcall;
  external 'computenetwork.dll' name 'HcnEnumerateEndpoints';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "HcnEnumerateEndpoints"
  c_HcnEnumerateEndpoints :: CWString -> Ptr CWString -> Ptr CWString -> IO Int32
-- Query : LPCWSTR -> CWString
-- Endpoints : LPWSTR* out -> Ptr CWString
-- ErrorRecord : LPWSTR* optional, out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let hcnenumerateendpoints =
  foreign "HcnEnumerateEndpoints"
    ((ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* Query : LPCWSTR -> (ptr uint16_t) *)
(* Endpoints : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* ErrorRecord : LPWSTR* optional, out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library computenetwork (t "computenetwork.dll"))
(cffi:use-foreign-library computenetwork)

(cffi:defcfun ("HcnEnumerateEndpoints" hcn-enumerate-endpoints :convention :stdcall) :int32
  (query (:string :encoding :utf-16le))   ; LPCWSTR
  (endpoints :pointer)   ; LPWSTR* out
  (error-record :pointer))   ; LPWSTR* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HcnEnumerateEndpoints = Win32::API::More->new('computenetwork',
    'int HcnEnumerateEndpoints(LPCWSTR Query, LPVOID Endpoints, LPVOID ErrorRecord)');
# my $ret = $HcnEnumerateEndpoints->Call($Query, $Endpoints, $ErrorRecord);
# Query : LPCWSTR -> LPCWSTR
# Endpoints : LPWSTR* out -> LPVOID
# ErrorRecord : LPWSTR* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。