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

DCompositionGetFrameId

関数
指定種別の合成フレームIDを取得する。
DLLdcomp.dll呼出規約winapi

シグネチャ

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

HRESULT DCompositionGetFrameId(
    COMPOSITION_FRAME_ID_TYPE frameIdType,
    ULONGLONG* frameId
);

パラメーター

名前方向説明
frameIdTypeCOMPOSITION_FRAME_ID_TYPEin取得するフレームIDの種別を示す列挙値。
frameIdULONGLONG*out取得したコンポジションフレームIDを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT DCompositionGetFrameId(
    COMPOSITION_FRAME_ID_TYPE frameIdType,
    ULONGLONG* frameId
);
[DllImport("dcomp.dll", ExactSpelling = true)]
static extern int DCompositionGetFrameId(
    int frameIdType,   // COMPOSITION_FRAME_ID_TYPE
    out ulong frameId   // ULONGLONG* out
);
<DllImport("dcomp.dll", ExactSpelling:=True)>
Public Shared Function DCompositionGetFrameId(
    frameIdType As Integer,   ' COMPOSITION_FRAME_ID_TYPE
    <Out> ByRef frameId As ULong   ' ULONGLONG* out
) As Integer
End Function
' frameIdType : COMPOSITION_FRAME_ID_TYPE
' frameId : ULONGLONG* out
Declare PtrSafe Function DCompositionGetFrameId Lib "dcomp" ( _
    ByVal frameIdType As Long, _
    ByRef frameId As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DCompositionGetFrameId = ctypes.windll.dcomp.DCompositionGetFrameId
DCompositionGetFrameId.restype = ctypes.c_int
DCompositionGetFrameId.argtypes = [
    ctypes.c_int,  # frameIdType : COMPOSITION_FRAME_ID_TYPE
    ctypes.POINTER(ctypes.c_ulonglong),  # frameId : ULONGLONG* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dcomp = windows.NewLazySystemDLL("dcomp.dll")
	procDCompositionGetFrameId = dcomp.NewProc("DCompositionGetFrameId")
)

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

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

typedef DCompositionGetFrameIdNative = Int32 Function(Int32, Pointer<Uint64>);
typedef DCompositionGetFrameIdDart = int Function(int, Pointer<Uint64>);
final DCompositionGetFrameId = DynamicLibrary.open('dcomp.dll')
    .lookupFunction<DCompositionGetFrameIdNative, DCompositionGetFrameIdDart>('DCompositionGetFrameId');
// frameIdType : COMPOSITION_FRAME_ID_TYPE -> Int32
// frameId : ULONGLONG* out -> Pointer<Uint64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DCompositionGetFrameId(
  frameIdType: Integer;   // COMPOSITION_FRAME_ID_TYPE
  frameId: Pointer   // ULONGLONG* out
): Integer; stdcall;
  external 'dcomp.dll' name 'DCompositionGetFrameId';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DCompositionGetFrameId"
  c_DCompositionGetFrameId :: Int32 -> Ptr Word64 -> IO Int32
-- frameIdType : COMPOSITION_FRAME_ID_TYPE -> Int32
-- frameId : ULONGLONG* out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dcompositiongetframeid =
  foreign "DCompositionGetFrameId"
    (int32_t @-> (ptr uint64_t) @-> returning int32_t)
(* frameIdType : COMPOSITION_FRAME_ID_TYPE -> int32_t *)
(* frameId : ULONGLONG* out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dcomp (t "dcomp.dll"))
(cffi:use-foreign-library dcomp)

(cffi:defcfun ("DCompositionGetFrameId" dcomposition-get-frame-id :convention :stdcall) :int32
  (frame-id-type :int32)   ; COMPOSITION_FRAME_ID_TYPE
  (frame-id :pointer))   ; ULONGLONG* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DCompositionGetFrameId = Win32::API::More->new('dcomp',
    'int DCompositionGetFrameId(int frameIdType, LPVOID frameId)');
# my $ret = $DCompositionGetFrameId->Call($frameIdType, $frameId);
# frameIdType : COMPOSITION_FRAME_ID_TYPE -> int
# frameId : ULONGLONG* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型