Win32 API 日本語リファレンス
ホーム › Media.KernelStreaming › KsCreatePin

KsCreatePin

関数
カーネルストリーミングフィルターにピン接続を生成する。
DLLksuser.dll呼出規約winapi

シグネチャ

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

DWORD KsCreatePin(
    HANDLE FilterHandle,
    KSPIN_CONNECT* Connect,
    DWORD DesiredAccess,
    HANDLE* ConnectionHandle
);

パラメーター

名前型方向説明
FilterHandleHANDLEinピンを生成する対象のフィルターのハンドル。
ConnectKSPIN_CONNECT*inピンの接続条件を示すKSPIN_CONNECT構造体へのポインター。データ形式等を含む。
DesiredAccessDWORDinピンに要求するアクセス権を示すフラグ。GENERIC_READ/WRITE等を指定する。
ConnectionHandleHANDLE*out生成されたピン(接続)のハンドルを受け取るポインター。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD KsCreatePin(
    HANDLE FilterHandle,
    KSPIN_CONNECT* Connect,
    DWORD DesiredAccess,
    HANDLE* ConnectionHandle
);
[DllImport("ksuser.dll", ExactSpelling = true)]
static extern uint KsCreatePin(
    IntPtr FilterHandle,   // HANDLE
    IntPtr Connect,   // KSPIN_CONNECT*
    uint DesiredAccess,   // DWORD
    IntPtr ConnectionHandle   // HANDLE* out
);
<DllImport("ksuser.dll", ExactSpelling:=True)>
Public Shared Function KsCreatePin(
    FilterHandle As IntPtr,   ' HANDLE
    Connect As IntPtr,   ' KSPIN_CONNECT*
    DesiredAccess As UInteger,   ' DWORD
    ConnectionHandle As IntPtr   ' HANDLE* out
) As UInteger
End Function
' FilterHandle : HANDLE
' Connect : KSPIN_CONNECT*
' DesiredAccess : DWORD
' ConnectionHandle : HANDLE* out
Declare PtrSafe Function KsCreatePin Lib "ksuser" ( _
    ByVal FilterHandle As LongPtr, _
    ByVal Connect As LongPtr, _
    ByVal DesiredAccess As Long, _
    ByVal ConnectionHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

KsCreatePin = ctypes.windll.ksuser.KsCreatePin
KsCreatePin.restype = wintypes.DWORD
KsCreatePin.argtypes = [
    wintypes.HANDLE,  # FilterHandle : HANDLE
    ctypes.c_void_p,  # Connect : KSPIN_CONNECT*
    wintypes.DWORD,  # DesiredAccess : DWORD
    ctypes.c_void_p,  # ConnectionHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ksuser = windows.NewLazySystemDLL("ksuser.dll")
	procKsCreatePin = ksuser.NewProc("KsCreatePin")
)

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

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

typedef KsCreatePinNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Void>);
typedef KsCreatePinDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Void>);
final KsCreatePin = DynamicLibrary.open('ksuser.dll')
    .lookupFunction<KsCreatePinNative, KsCreatePinDart>('KsCreatePin');
// FilterHandle : HANDLE -> Pointer<Void>
// Connect : KSPIN_CONNECT* -> Pointer<Void>
// DesiredAccess : DWORD -> Uint32
// ConnectionHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function KsCreatePin(
  FilterHandle: THandle;   // HANDLE
  Connect: Pointer;   // KSPIN_CONNECT*
  DesiredAccess: DWORD;   // DWORD
  ConnectionHandle: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'ksuser.dll' name 'KsCreatePin';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "KsCreatePin"
  c_KsCreatePin :: Ptr () -> Ptr () -> Word32 -> Ptr () -> IO Word32
-- FilterHandle : HANDLE -> Ptr ()
-- Connect : KSPIN_CONNECT* -> Ptr ()
-- DesiredAccess : DWORD -> Word32
-- ConnectionHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let kscreatepin =
  foreign "KsCreatePin"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* FilterHandle : HANDLE -> (ptr void) *)
(* Connect : KSPIN_CONNECT* -> (ptr void) *)
(* DesiredAccess : DWORD -> uint32_t *)
(* ConnectionHandle : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ksuser (t "ksuser.dll"))
(cffi:use-foreign-library ksuser)

(cffi:defcfun ("KsCreatePin" ks-create-pin :convention :stdcall) :uint32
  (filter-handle :pointer)   ; HANDLE
  (connect :pointer)   ; KSPIN_CONNECT*
  (desired-access :uint32)   ; DWORD
  (connection-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $KsCreatePin = Win32::API::More->new('ksuser',
    'DWORD KsCreatePin(HANDLE FilterHandle, LPVOID Connect, DWORD DesiredAccess, HANDLE ConnectionHandle)');
# my $ret = $KsCreatePin->Call($FilterHandle, $Connect, $DesiredAccess, $ConnectionHandle);
# FilterHandle : HANDLE -> HANDLE
# Connect : KSPIN_CONNECT* -> LPVOID
# DesiredAccess : DWORD -> DWORD
# ConnectionHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型