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

CoGetContextToken

関数
現在のオブジェクトコンテキストのトークンを取得する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoGetContextToken(
    UINT_PTR* pToken
);

パラメーター

名前方向説明
pTokenUINT_PTR*out現在のコンテキストに対する IObjContext の実装へのポインター。

戻り値の型: HRESULT

公式ドキュメント

現在のコンテキストに対する IObjContext の実装へのポインターを返します。

戻り値

この関数は次の値を返すことがあります。

戻り値 説明
S_OK
トークンが正常に取得されました。
E_POINTER
呼び出し元が有効なトークンポインター変数を渡しませんでした。
CO_E_NOTINITIALIZED
呼び出し元が初期化済みのアパートメント内にいません。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT CoGetContextToken(
    UINT_PTR* pToken
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoGetContextToken(
    out UIntPtr pToken   // UINT_PTR* out
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoGetContextToken(
    <Out> ByRef pToken As UIntPtr   ' UINT_PTR* out
) As Integer
End Function
' pToken : UINT_PTR* out
Declare PtrSafe Function CoGetContextToken Lib "ole32" ( _
    ByRef pToken As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoGetContextToken = ctypes.windll.ole32.CoGetContextToken
CoGetContextToken.restype = ctypes.c_int
CoGetContextToken.argtypes = [
    ctypes.POINTER(ctypes.c_size_t),  # pToken : UINT_PTR* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoGetContextToken = ole32.NewProc("CoGetContextToken")
)

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

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

typedef CoGetContextTokenNative = Int32 Function(Pointer<UintPtr>);
typedef CoGetContextTokenDart = int Function(Pointer<UintPtr>);
final CoGetContextToken = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoGetContextTokenNative, CoGetContextTokenDart>('CoGetContextToken');
// pToken : UINT_PTR* out -> Pointer<UintPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoGetContextToken(
  pToken: Pointer   // UINT_PTR* out
): Integer; stdcall;
  external 'OLE32.dll' name 'CoGetContextToken';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoGetContextToken"
  c_CoGetContextToken :: Ptr CUIntPtr -> IO Int32
-- pToken : UINT_PTR* out -> Ptr CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cogetcontexttoken =
  foreign "CoGetContextToken"
    ((ptr size_t) @-> returning int32_t)
(* pToken : UINT_PTR* out -> (ptr size_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoGetContextToken" co-get-context-token :convention :stdcall) :int32
  (p-token :pointer))   ; UINT_PTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoGetContextToken = Win32::API::More->new('OLE32',
    'int CoGetContextToken(LPVOID pToken)');
# my $ret = $CoGetContextToken->Call($pToken);
# pToken : UINT_PTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目