Win32 API 日本語リファレンス
ホームGaming › ShowGameInviteUI

ShowGameInviteUI

関数
ゲームへの招待を送るためのUIを表示する。
DLLapi-ms-win-gaming-tcui-l1-1-0.dll呼出規約winapi

シグネチャ

// api-ms-win-gaming-tcui-l1-1-0.dll
#include <windows.h>

HRESULT ShowGameInviteUI(
    HSTRING serviceConfigurationId,
    HSTRING sessionTemplateName,
    HSTRING sessionId,
    HSTRING invitationDisplayText,
    GameUICompletionRoutine completionRoutine,
    void* context   // optional
);

パラメーター

名前方向
serviceConfigurationIdHSTRINGin
sessionTemplateNameHSTRINGin
sessionIdHSTRINGin
invitationDisplayTextHSTRINGin
completionRoutineGameUICompletionRoutinein
contextvoid*inoptional

戻り値の型: HRESULT

各言語での呼び出し定義

// api-ms-win-gaming-tcui-l1-1-0.dll
#include <windows.h>

HRESULT ShowGameInviteUI(
    HSTRING serviceConfigurationId,
    HSTRING sessionTemplateName,
    HSTRING sessionId,
    HSTRING invitationDisplayText,
    GameUICompletionRoutine completionRoutine,
    void* context   // optional
);
[DllImport("api-ms-win-gaming-tcui-l1-1-0.dll", ExactSpelling = true)]
static extern int ShowGameInviteUI(
    IntPtr serviceConfigurationId,   // HSTRING
    IntPtr sessionTemplateName,   // HSTRING
    IntPtr sessionId,   // HSTRING
    IntPtr invitationDisplayText,   // HSTRING
    IntPtr completionRoutine,   // GameUICompletionRoutine
    IntPtr context   // void* optional
);
<DllImport("api-ms-win-gaming-tcui-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function ShowGameInviteUI(
    serviceConfigurationId As IntPtr,   ' HSTRING
    sessionTemplateName As IntPtr,   ' HSTRING
    sessionId As IntPtr,   ' HSTRING
    invitationDisplayText As IntPtr,   ' HSTRING
    completionRoutine As IntPtr,   ' GameUICompletionRoutine
    context As IntPtr   ' void* optional
) As Integer
End Function
' serviceConfigurationId : HSTRING
' sessionTemplateName : HSTRING
' sessionId : HSTRING
' invitationDisplayText : HSTRING
' completionRoutine : GameUICompletionRoutine
' context : void* optional
Declare PtrSafe Function ShowGameInviteUI Lib "api-ms-win-gaming-tcui-l1-1-0" ( _
    ByVal serviceConfigurationId As LongPtr, _
    ByVal sessionTemplateName As LongPtr, _
    ByVal sessionId As LongPtr, _
    ByVal invitationDisplayText As LongPtr, _
    ByVal completionRoutine As LongPtr, _
    ByVal context As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ShowGameInviteUI = ctypes.windll.LoadLibrary("api-ms-win-gaming-tcui-l1-1-0.dll").ShowGameInviteUI
ShowGameInviteUI.restype = ctypes.c_int
ShowGameInviteUI.argtypes = [
    wintypes.HANDLE,  # serviceConfigurationId : HSTRING
    wintypes.HANDLE,  # sessionTemplateName : HSTRING
    wintypes.HANDLE,  # sessionId : HSTRING
    wintypes.HANDLE,  # invitationDisplayText : HSTRING
    ctypes.c_void_p,  # completionRoutine : GameUICompletionRoutine
    ctypes.POINTER(None),  # context : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-gaming-tcui-l1-1-0.dll')
ShowGameInviteUI = Fiddle::Function.new(
  lib['ShowGameInviteUI'],
  [
    Fiddle::TYPE_VOIDP,  # serviceConfigurationId : HSTRING
    Fiddle::TYPE_VOIDP,  # sessionTemplateName : HSTRING
    Fiddle::TYPE_VOIDP,  # sessionId : HSTRING
    Fiddle::TYPE_VOIDP,  # invitationDisplayText : HSTRING
    Fiddle::TYPE_VOIDP,  # completionRoutine : GameUICompletionRoutine
    Fiddle::TYPE_VOIDP,  # context : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-gaming-tcui-l1-1-0")]
extern "system" {
    fn ShowGameInviteUI(
        serviceConfigurationId: *mut core::ffi::c_void,  // HSTRING
        sessionTemplateName: *mut core::ffi::c_void,  // HSTRING
        sessionId: *mut core::ffi::c_void,  // HSTRING
        invitationDisplayText: *mut core::ffi::c_void,  // HSTRING
        completionRoutine: *const core::ffi::c_void,  // GameUICompletionRoutine
        context: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("api-ms-win-gaming-tcui-l1-1-0.dll")]
public static extern int ShowGameInviteUI(IntPtr serviceConfigurationId, IntPtr sessionTemplateName, IntPtr sessionId, IntPtr invitationDisplayText, IntPtr completionRoutine, IntPtr context);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-gaming-tcui-l1-1-0_ShowGameInviteUI' -Namespace Win32 -PassThru
# $api::ShowGameInviteUI(serviceConfigurationId, sessionTemplateName, sessionId, invitationDisplayText, completionRoutine, context)
#uselib "api-ms-win-gaming-tcui-l1-1-0.dll"
#func global ShowGameInviteUI "ShowGameInviteUI" sptr, sptr, sptr, sptr, sptr, sptr
; ShowGameInviteUI serviceConfigurationId, sessionTemplateName, sessionId, invitationDisplayText, completionRoutine, context   ; 戻り値は stat
; serviceConfigurationId : HSTRING -> "sptr"
; sessionTemplateName : HSTRING -> "sptr"
; sessionId : HSTRING -> "sptr"
; invitationDisplayText : HSTRING -> "sptr"
; completionRoutine : GameUICompletionRoutine -> "sptr"
; context : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-gaming-tcui-l1-1-0.dll"
#cfunc global ShowGameInviteUI "ShowGameInviteUI" sptr, sptr, sptr, sptr, sptr, sptr
; res = ShowGameInviteUI(serviceConfigurationId, sessionTemplateName, sessionId, invitationDisplayText, completionRoutine, context)
; serviceConfigurationId : HSTRING -> "sptr"
; sessionTemplateName : HSTRING -> "sptr"
; sessionId : HSTRING -> "sptr"
; invitationDisplayText : HSTRING -> "sptr"
; completionRoutine : GameUICompletionRoutine -> "sptr"
; context : void* optional -> "sptr"
; HRESULT ShowGameInviteUI(HSTRING serviceConfigurationId, HSTRING sessionTemplateName, HSTRING sessionId, HSTRING invitationDisplayText, GameUICompletionRoutine completionRoutine, void* context)
#uselib "api-ms-win-gaming-tcui-l1-1-0.dll"
#cfunc global ShowGameInviteUI "ShowGameInviteUI" intptr, intptr, intptr, intptr, intptr, intptr
; res = ShowGameInviteUI(serviceConfigurationId, sessionTemplateName, sessionId, invitationDisplayText, completionRoutine, context)
; serviceConfigurationId : HSTRING -> "intptr"
; sessionTemplateName : HSTRING -> "intptr"
; sessionId : HSTRING -> "intptr"
; invitationDisplayText : HSTRING -> "intptr"
; completionRoutine : GameUICompletionRoutine -> "intptr"
; context : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_gaming_tcui_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-gaming-tcui-l1-1-0.dll")
	procShowGameInviteUI = api_ms_win_gaming_tcui_l1_1_0.NewProc("ShowGameInviteUI")
)

// serviceConfigurationId (HSTRING), sessionTemplateName (HSTRING), sessionId (HSTRING), invitationDisplayText (HSTRING), completionRoutine (GameUICompletionRoutine), context (void* optional)
r1, _, err := procShowGameInviteUI.Call(
	uintptr(serviceConfigurationId),
	uintptr(sessionTemplateName),
	uintptr(sessionId),
	uintptr(invitationDisplayText),
	uintptr(completionRoutine),
	uintptr(context),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function ShowGameInviteUI(
  serviceConfigurationId: THandle;   // HSTRING
  sessionTemplateName: THandle;   // HSTRING
  sessionId: THandle;   // HSTRING
  invitationDisplayText: THandle;   // HSTRING
  completionRoutine: Pointer;   // GameUICompletionRoutine
  context: Pointer   // void* optional
): Integer; stdcall;
  external 'api-ms-win-gaming-tcui-l1-1-0.dll' name 'ShowGameInviteUI';
result := DllCall("api-ms-win-gaming-tcui-l1-1-0\ShowGameInviteUI"
    , "Ptr", serviceConfigurationId   ; HSTRING
    , "Ptr", sessionTemplateName   ; HSTRING
    , "Ptr", sessionId   ; HSTRING
    , "Ptr", invitationDisplayText   ; HSTRING
    , "Ptr", completionRoutine   ; GameUICompletionRoutine
    , "Ptr", context   ; void* optional
    , "Int")   ; return: HRESULT
●ShowGameInviteUI(serviceConfigurationId, sessionTemplateName, sessionId, invitationDisplayText, completionRoutine, context) = DLL("api-ms-win-gaming-tcui-l1-1-0.dll", "int ShowGameInviteUI(void*, void*, void*, void*, void*, void*)")
# 呼び出し: ShowGameInviteUI(serviceConfigurationId, sessionTemplateName, sessionId, invitationDisplayText, completionRoutine, context)
# serviceConfigurationId : HSTRING -> "void*"
# sessionTemplateName : HSTRING -> "void*"
# sessionId : HSTRING -> "void*"
# invitationDisplayText : HSTRING -> "void*"
# completionRoutine : GameUICompletionRoutine -> "void*"
# context : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。