Win32 API 日本語リファレンス
ホームStorage.Packaging.Appx › FormatApplicationUserModelId

FormatApplicationUserModelId

関数
ファミリ名とアプリIDからユーザーモデルIDを組み立てる。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

WIN32_ERROR FormatApplicationUserModelId(
    LPCWSTR packageFamilyName,
    LPCWSTR packageRelativeApplicationId,
    DWORD* applicationUserModelIdLength,
    LPWSTR applicationUserModelId   // optional
);

パラメーター

名前方向
packageFamilyNameLPCWSTRin
packageRelativeApplicationIdLPCWSTRin
applicationUserModelIdLengthDWORD*inout
applicationUserModelIdLPWSTRoutoptional

戻り値の型: WIN32_ERROR

各言語での呼び出し定義

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

WIN32_ERROR FormatApplicationUserModelId(
    LPCWSTR packageFamilyName,
    LPCWSTR packageRelativeApplicationId,
    DWORD* applicationUserModelIdLength,
    LPWSTR applicationUserModelId   // optional
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint FormatApplicationUserModelId(
    [MarshalAs(UnmanagedType.LPWStr)] string packageFamilyName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string packageRelativeApplicationId,   // LPCWSTR
    ref uint applicationUserModelIdLength,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder applicationUserModelId   // LPWSTR optional, out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function FormatApplicationUserModelId(
    <MarshalAs(UnmanagedType.LPWStr)> packageFamilyName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> packageRelativeApplicationId As String,   ' LPCWSTR
    ByRef applicationUserModelIdLength As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> applicationUserModelId As System.Text.StringBuilder   ' LPWSTR optional, out
) As UInteger
End Function
' packageFamilyName : LPCWSTR
' packageRelativeApplicationId : LPCWSTR
' applicationUserModelIdLength : DWORD* in/out
' applicationUserModelId : LPWSTR optional, out
Declare PtrSafe Function FormatApplicationUserModelId Lib "kernel32" ( _
    ByVal packageFamilyName As LongPtr, _
    ByVal packageRelativeApplicationId As LongPtr, _
    ByRef applicationUserModelIdLength As Long, _
    ByVal applicationUserModelId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FormatApplicationUserModelId = ctypes.windll.kernel32.FormatApplicationUserModelId
FormatApplicationUserModelId.restype = wintypes.DWORD
FormatApplicationUserModelId.argtypes = [
    wintypes.LPCWSTR,  # packageFamilyName : LPCWSTR
    wintypes.LPCWSTR,  # packageRelativeApplicationId : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # applicationUserModelIdLength : DWORD* in/out
    wintypes.LPWSTR,  # applicationUserModelId : LPWSTR optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FormatApplicationUserModelId = Fiddle::Function.new(
  lib['FormatApplicationUserModelId'],
  [
    Fiddle::TYPE_VOIDP,  # packageFamilyName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # packageRelativeApplicationId : LPCWSTR
    Fiddle::TYPE_VOIDP,  # applicationUserModelIdLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # applicationUserModelId : LPWSTR optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn FormatApplicationUserModelId(
        packageFamilyName: *const u16,  // LPCWSTR
        packageRelativeApplicationId: *const u16,  // LPCWSTR
        applicationUserModelIdLength: *mut u32,  // DWORD* in/out
        applicationUserModelId: *mut u16  // LPWSTR optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint FormatApplicationUserModelId([MarshalAs(UnmanagedType.LPWStr)] string packageFamilyName, [MarshalAs(UnmanagedType.LPWStr)] string packageRelativeApplicationId, ref uint applicationUserModelIdLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder applicationUserModelId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FormatApplicationUserModelId' -Namespace Win32 -PassThru
# $api::FormatApplicationUserModelId(packageFamilyName, packageRelativeApplicationId, applicationUserModelIdLength, applicationUserModelId)
#uselib "KERNEL32.dll"
#func global FormatApplicationUserModelId "FormatApplicationUserModelId" sptr, sptr, sptr, sptr
; FormatApplicationUserModelId packageFamilyName, packageRelativeApplicationId, varptr(applicationUserModelIdLength), varptr(applicationUserModelId)   ; 戻り値は stat
; packageFamilyName : LPCWSTR -> "sptr"
; packageRelativeApplicationId : LPCWSTR -> "sptr"
; applicationUserModelIdLength : DWORD* in/out -> "sptr"
; applicationUserModelId : LPWSTR optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global FormatApplicationUserModelId "FormatApplicationUserModelId" wstr, wstr, var, var
; res = FormatApplicationUserModelId(packageFamilyName, packageRelativeApplicationId, applicationUserModelIdLength, applicationUserModelId)
; packageFamilyName : LPCWSTR -> "wstr"
; packageRelativeApplicationId : LPCWSTR -> "wstr"
; applicationUserModelIdLength : DWORD* in/out -> "var"
; applicationUserModelId : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; WIN32_ERROR FormatApplicationUserModelId(LPCWSTR packageFamilyName, LPCWSTR packageRelativeApplicationId, DWORD* applicationUserModelIdLength, LPWSTR applicationUserModelId)
#uselib "KERNEL32.dll"
#cfunc global FormatApplicationUserModelId "FormatApplicationUserModelId" wstr, wstr, var, var
; res = FormatApplicationUserModelId(packageFamilyName, packageRelativeApplicationId, applicationUserModelIdLength, applicationUserModelId)
; packageFamilyName : LPCWSTR -> "wstr"
; packageRelativeApplicationId : LPCWSTR -> "wstr"
; applicationUserModelIdLength : DWORD* in/out -> "var"
; applicationUserModelId : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFormatApplicationUserModelId = kernel32.NewProc("FormatApplicationUserModelId")
)

// packageFamilyName (LPCWSTR), packageRelativeApplicationId (LPCWSTR), applicationUserModelIdLength (DWORD* in/out), applicationUserModelId (LPWSTR optional, out)
r1, _, err := procFormatApplicationUserModelId.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(packageFamilyName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(packageRelativeApplicationId))),
	uintptr(applicationUserModelIdLength),
	uintptr(applicationUserModelId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function FormatApplicationUserModelId(
  packageFamilyName: PWideChar;   // LPCWSTR
  packageRelativeApplicationId: PWideChar;   // LPCWSTR
  applicationUserModelIdLength: Pointer;   // DWORD* in/out
  applicationUserModelId: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'FormatApplicationUserModelId';
result := DllCall("KERNEL32\FormatApplicationUserModelId"
    , "WStr", packageFamilyName   ; LPCWSTR
    , "WStr", packageRelativeApplicationId   ; LPCWSTR
    , "Ptr", applicationUserModelIdLength   ; DWORD* in/out
    , "Ptr", applicationUserModelId   ; LPWSTR optional, out
    , "UInt")   ; return: WIN32_ERROR
●FormatApplicationUserModelId(packageFamilyName, packageRelativeApplicationId, applicationUserModelIdLength, applicationUserModelId) = DLL("KERNEL32.dll", "dword FormatApplicationUserModelId(char*, char*, void*, char*)")
# 呼び出し: FormatApplicationUserModelId(packageFamilyName, packageRelativeApplicationId, applicationUserModelIdLength, applicationUserModelId)
# packageFamilyName : LPCWSTR -> "char*"
# packageRelativeApplicationId : LPCWSTR -> "char*"
# applicationUserModelIdLength : DWORD* in/out -> "void*"
# applicationUserModelId : LPWSTR optional, out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。