Win32 API 日本語リファレンス
ホームGraphics.DirectComposition › DCompositionCreateSurfaceHandle

DCompositionCreateSurfaceHandle

関数
合成サーフェスを表すハンドルを作成する。
DLLdcomp.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT DCompositionCreateSurfaceHandle(
    DWORD desiredAccess,
    SECURITY_ATTRIBUTES* securityAttributes,   // optional
    HANDLE* surfaceHandle
);

パラメーター

名前方向説明
desiredAccessDWORDin生成するサーフェスハンドルへのアクセス権を示すマスク。
securityAttributesSECURITY_ATTRIBUTES*inoptionalハンドルの継承やセキュリティを定める属性。NULL可。
surfaceHandleHANDLE*out生成された合成サーフェスのハンドルを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT DCompositionCreateSurfaceHandle(
    DWORD desiredAccess,
    SECURITY_ATTRIBUTES* securityAttributes,   // optional
    HANDLE* surfaceHandle
);
[DllImport("dcomp.dll", ExactSpelling = true)]
static extern int DCompositionCreateSurfaceHandle(
    uint desiredAccess,   // DWORD
    IntPtr securityAttributes,   // SECURITY_ATTRIBUTES* optional
    IntPtr surfaceHandle   // HANDLE* out
);
<DllImport("dcomp.dll", ExactSpelling:=True)>
Public Shared Function DCompositionCreateSurfaceHandle(
    desiredAccess As UInteger,   ' DWORD
    securityAttributes As IntPtr,   ' SECURITY_ATTRIBUTES* optional
    surfaceHandle As IntPtr   ' HANDLE* out
) As Integer
End Function
' desiredAccess : DWORD
' securityAttributes : SECURITY_ATTRIBUTES* optional
' surfaceHandle : HANDLE* out
Declare PtrSafe Function DCompositionCreateSurfaceHandle Lib "dcomp" ( _
    ByVal desiredAccess As Long, _
    ByVal securityAttributes As LongPtr, _
    ByVal surfaceHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DCompositionCreateSurfaceHandle = ctypes.windll.dcomp.DCompositionCreateSurfaceHandle
DCompositionCreateSurfaceHandle.restype = ctypes.c_int
DCompositionCreateSurfaceHandle.argtypes = [
    wintypes.DWORD,  # desiredAccess : DWORD
    ctypes.c_void_p,  # securityAttributes : SECURITY_ATTRIBUTES* optional
    ctypes.c_void_p,  # surfaceHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dcomp = windows.NewLazySystemDLL("dcomp.dll")
	procDCompositionCreateSurfaceHandle = dcomp.NewProc("DCompositionCreateSurfaceHandle")
)

// desiredAccess (DWORD), securityAttributes (SECURITY_ATTRIBUTES* optional), surfaceHandle (HANDLE* out)
r1, _, err := procDCompositionCreateSurfaceHandle.Call(
	uintptr(desiredAccess),
	uintptr(securityAttributes),
	uintptr(surfaceHandle),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function DCompositionCreateSurfaceHandle(
  desiredAccess: DWORD;   // DWORD
  securityAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  surfaceHandle: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'dcomp.dll' name 'DCompositionCreateSurfaceHandle';
result := DllCall("dcomp\DCompositionCreateSurfaceHandle"
    , "UInt", desiredAccess   ; DWORD
    , "Ptr", securityAttributes   ; SECURITY_ATTRIBUTES* optional
    , "Ptr", surfaceHandle   ; HANDLE* out
    , "Int")   ; return: HRESULT
●DCompositionCreateSurfaceHandle(desiredAccess, securityAttributes, surfaceHandle) = DLL("dcomp.dll", "int DCompositionCreateSurfaceHandle(dword, void*, void*)")
# 呼び出し: DCompositionCreateSurfaceHandle(desiredAccess, securityAttributes, surfaceHandle)
# desiredAccess : DWORD -> "dword"
# securityAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# surfaceHandle : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef DCompositionCreateSurfaceHandleNative = Int32 Function(Uint32, Pointer<Void>, Pointer<Void>);
typedef DCompositionCreateSurfaceHandleDart = int Function(int, Pointer<Void>, Pointer<Void>);
final DCompositionCreateSurfaceHandle = DynamicLibrary.open('dcomp.dll')
    .lookupFunction<DCompositionCreateSurfaceHandleNative, DCompositionCreateSurfaceHandleDart>('DCompositionCreateSurfaceHandle');
// desiredAccess : DWORD -> Uint32
// securityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// surfaceHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DCompositionCreateSurfaceHandle(
  desiredAccess: DWORD;   // DWORD
  securityAttributes: Pointer;   // SECURITY_ATTRIBUTES* optional
  surfaceHandle: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'dcomp.dll' name 'DCompositionCreateSurfaceHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DCompositionCreateSurfaceHandle"
  c_DCompositionCreateSurfaceHandle :: Word32 -> Ptr () -> Ptr () -> IO Int32
-- desiredAccess : DWORD -> Word32
-- securityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- surfaceHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dcompositioncreatesurfacehandle =
  foreign "DCompositionCreateSurfaceHandle"
    (uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* desiredAccess : DWORD -> uint32_t *)
(* securityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* surfaceHandle : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dcomp (t "dcomp.dll"))
(cffi:use-foreign-library dcomp)

(cffi:defcfun ("DCompositionCreateSurfaceHandle" dcomposition-create-surface-handle :convention :stdcall) :int32
  (desired-access :uint32)   ; DWORD
  (security-attributes :pointer)   ; SECURITY_ATTRIBUTES* optional
  (surface-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DCompositionCreateSurfaceHandle = Win32::API::More->new('dcomp',
    'int DCompositionCreateSurfaceHandle(DWORD desiredAccess, LPVOID securityAttributes, HANDLE surfaceHandle)');
# my $ret = $DCompositionCreateSurfaceHandle->Call($desiredAccess, $securityAttributes, $surfaceHandle);
# desiredAccess : DWORD -> DWORD
# securityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# surfaceHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型