Win32 API 日本語リファレンス
ホームDevices.Display › CLIPOBJ_ppoGetPath

CLIPOBJ_ppoGetPath

関数
クリップオブジェクトの境界をパスオブジェクトとして取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

PATHOBJ* CLIPOBJ_ppoGetPath(
    CLIPOBJ* pco
);

パラメーター

名前方向説明
pcoCLIPOBJ*inout指定されたクリップ領域を定義する CLIPOBJ 構造体へのポインターです。

戻り値の型: PATHOBJ*

公式ドキュメント

CLIPOBJ_ppoGetPath 関数は、指定されたクリップ領域の輪郭を含む PATHOBJ 構造体を作成します。

戻り値

関数が成功した場合、戻り値は PATHOBJ 構造体へのポインターです。それ以外の場合は NULL となり、エラーコードがログに記録されます。

解説(Remarks)

返された PATHOBJ 構造体は、ドライバーが不要になった時点で EngDeletePath を使用して削除する必要があります。

クリッピングパスをダウンロードできるデバイスのドライバーでは、複雑な領域を定義する際にこの関数の使用が推奨される場合があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

PATHOBJ* CLIPOBJ_ppoGetPath(
    CLIPOBJ* pco
);
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern IntPtr CLIPOBJ_ppoGetPath(
    IntPtr pco   // CLIPOBJ* in/out
);
<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function CLIPOBJ_ppoGetPath(
    pco As IntPtr   ' CLIPOBJ* in/out
) As IntPtr
End Function
' pco : CLIPOBJ* in/out
Declare PtrSafe Function CLIPOBJ_ppoGetPath Lib "gdi32" ( _
    ByVal pco As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CLIPOBJ_ppoGetPath = ctypes.windll.gdi32.CLIPOBJ_ppoGetPath
CLIPOBJ_ppoGetPath.restype = ctypes.c_void_p
CLIPOBJ_ppoGetPath.argtypes = [
    ctypes.c_void_p,  # pco : CLIPOBJ* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procCLIPOBJ_ppoGetPath = gdi32.NewProc("CLIPOBJ_ppoGetPath")
)

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

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

typedef CLIPOBJ_ppoGetPathNative = Pointer<Void> Function(Pointer<Void>);
typedef CLIPOBJ_ppoGetPathDart = Pointer<Void> Function(Pointer<Void>);
final CLIPOBJ_ppoGetPath = DynamicLibrary.open('GDI32.dll')
    .lookupFunction<CLIPOBJ_ppoGetPathNative, CLIPOBJ_ppoGetPathDart>('CLIPOBJ_ppoGetPath');
// pco : CLIPOBJ* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CLIPOBJ_ppoGetPath(
  pco: Pointer   // CLIPOBJ* in/out
): Pointer; stdcall;
  external 'GDI32.dll' name 'CLIPOBJ_ppoGetPath';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CLIPOBJ_ppoGetPath"
  c_CLIPOBJ_ppoGetPath :: Ptr () -> IO (Ptr ())
-- pco : CLIPOBJ* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let clipobj_ppogetpath =
  foreign "CLIPOBJ_ppoGetPath"
    ((ptr void) @-> returning (ptr void))
(* pco : CLIPOBJ* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)

(cffi:defcfun ("CLIPOBJ_ppoGetPath" clipobj-ppo-get-path :convention :stdcall) :pointer
  (pco :pointer))   ; CLIPOBJ* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CLIPOBJ_ppoGetPath = Win32::API::More->new('GDI32',
    'LPVOID CLIPOBJ_ppoGetPath(LPVOID pco)');
# my $ret = $CLIPOBJ_ppoGetPath->Call($pco);
# pco : CLIPOBJ* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型