ホーム › Storage.Packaging.Appx › PackageIdFromFullName

PackageIdFromFullName

関数

パッケージフルネームを解析してパッケージID構造体を生成する。

DLLKERNEL32.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

WIN32_ERROR PackageIdFromFullName(
    LPCWSTR packageFullName,
    DWORD flags,
    DWORD* bufferLength,
    BYTE* buffer   // optional
);

パラメーター

名前	型	方向	説明
packageFullName	LPCWSTR	in	パッケージのフルネーム。
flags	DWORD	in	パッケージ情報の取得方法を指定するパッケージ定数。PACKAGE_INFORMATION_* フラグがサポートされます。
bufferLength	DWORD*	inout	入力時は buffer のサイズ (バイト単位)。出力時は、返されたデータのサイズ (バイト単位)。
buffer	BYTE*	outoptional	PACKAGE_ID 構造体として表されるパッケージ ID。

戻り値の型: WIN32_ERROR

公式ドキュメント

指定されたパッケージフルネームに対応するパッケージ識別子 (ID) を取得します。

戻り値

型: LONG

関数が成功した場合は ERROR_SUCCESS を返します。それ以外の場合は、エラーコードを返します。返される可能性のあるエラーコードには次のものがあります。

戻り値	説明
ERROR_INSUFFICIENT_BUFFER	バッファーがデータを格納するのに十分な大きさではありません。必要なサイズは bufferLength に格納されます。
ERROR_NOT_FOUND	そのパッケージはユーザー用にインストールされていません。

解説(Remarks)

flags に PACKAGE_INFORMATION_BASIC を指定した場合、次のフィールドが取得されます。

name
processorArchitecture
publisherId
resourceId
version

flags に PACKAGE_INFORMATION_FULL を指定した場合、次のフィールドが取得されます。

name
processorArchitecture
publisher
publisherId
resourceId
version

PACKAGE_INFORMATION_FULL の要求は、packageFullName に対応するパッケージが現在のユーザー用にインストールされ、そのユーザーがアクセスできる場合にのみ成功します。パッケージフルネームの構文が正しくても、現在のユーザー用にインストールされ、アクセス可能なパッケージに対応していない場合、この関数は ERROR_NOT_FOUND を返します。

文字列のサイズ制限については、Identity constants を参照してください。

例

#define _UNICODE 1
#define UNICODE 1

#include <Windows.h>
#include <appmodel.h>
#include <malloc.h>
#include <stdio.h>

int ShowUsage();
void FullNameToId(__in PCWSTR fullName, __in const UINT32 flags);
void ShowPackageId(__in const PACKAGE_ID * packageId);

int ShowUsage()
{
    wprintf(L"Usage: PackageIdFromFullName <[flags]fullname> [<[flags]fullname>...]\n"
            L"flags:\n"
            L"    ? = Basic information (PACKAGE_INFORMATION_BASIC)\n"
            L"    * = Full information (PACKAGE_INFORMATION_FULL)\n"
            L"Default = Basic\n");
    return 1;
}

int __cdecl wmain(__in int argc, __in_ecount(argc) WCHAR * argv[])
{
    if (argc <= 1)
        return ShowUsage();

    for (int i=1; i<argc; ++i)
    {
        PCWSTR fullName = argv[i];
        UINT32 flags = PACKAGE_INFORMATION_BASIC;
        if (*fullName != L'\0')
        {
            if (*fullName == L'?')
            {
                flags = PACKAGE_INFORMATION_BASIC;
                ++fullName;
            }
            else if (*fullName == L'*')
            {
                flags = PACKAGE_INFORMATION_FULL;
                ++fullName;
            }
        }
        FullNameToId(fullName, flags);
    }

    return 0;
}

void FullNameToId(__in PCWSTR fullName, __in const UINT32 flags)
{
    wprintf(L"FullName: %s%s\n", fullName, ((flags & PACKAGE_INFORMATION_FULL) == 0 ? L"  [BASIC]" : L"  [FULL]"));
    UINT32 length = 0;
    LONG rc = PackageIdFromFullName(fullName, flags, &length, NULL);
    if (rc == ERROR_SUCCESS)
    {
        wprintf(L"PackageIdFromFullName unexpected succeeded\n");
        return;
    }
    else if (rc != ERROR_INSUFFICIENT_BUFFER)
    {
        wprintf(L"Error %d in PackageIdFromFullName\n", rc);
        return;
    }

    BYTE * buffer = (PBYTE) malloc(length);
    if (buffer == NULL)
    {
        wprintf(L"Error allocating memory\n");
        return;
    }

    rc = PackageIdFromFullName(fullName, flags, &length, buffer);
    if (rc != ERROR_SUCCESS)
        wprintf(L"Error %d converting Package Full Name to Id\n", rc);
    else
    {
        ShowPackageId((PACKAGE_ID *) buffer);
    }

    free(buffer);
}

void ShowPackageId(__in const PACKAGE_ID * packageId)
{
    wprintf(L"    Name        : %s\n", packageId->name);
    if (packageId->publisher != NULL)
        wprintf(L"    Publisher   : %s\n", packageId->publisher);
    if (packageId->publisherId != NULL)
        wprintf(L"    PublisherId : %s\n", packageId->publisherId);
    wprintf(L"    Version     : %hu.%hu.%hu.%hu\n",
            packageId->version.Major,
            packageId->version.Minor,
            packageId->version.Build,
            packageId->version.Revision);
    wprintf(L"    Architecture: %u\n", packageId->processorArchitecture);
    if (packageId->resourceId != NULL)
        wprintf(L"    Resource    : %s\n", packageId->resourceId);
}

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

各言語での呼び出し定義

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

WIN32_ERROR PackageIdFromFullName(
    LPCWSTR packageFullName,
    DWORD flags,
    DWORD* bufferLength,
    BYTE* buffer   // optional
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint PackageIdFromFullName(
    [MarshalAs(UnmanagedType.LPWStr)] string packageFullName,   // LPCWSTR
    uint flags,   // DWORD
    ref uint bufferLength,   // DWORD* in/out
    IntPtr buffer   // BYTE* optional, out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function PackageIdFromFullName(
    <MarshalAs(UnmanagedType.LPWStr)> packageFullName As String,   ' LPCWSTR
    flags As UInteger,   ' DWORD
    ByRef bufferLength As UInteger,   ' DWORD* in/out
    buffer As IntPtr   ' BYTE* optional, out
) As UInteger
End Function

' packageFullName : LPCWSTR
' flags : DWORD
' bufferLength : DWORD* in/out
' buffer : BYTE* optional, out
Declare PtrSafe Function PackageIdFromFullName Lib "kernel32" ( _
    ByVal packageFullName As LongPtr, _
    ByVal flags As Long, _
    ByRef bufferLength As Long, _
    ByVal buffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PackageIdFromFullName = ctypes.windll.kernel32.PackageIdFromFullName
PackageIdFromFullName.restype = wintypes.DWORD
PackageIdFromFullName.argtypes = [
    wintypes.LPCWSTR,  # packageFullName : LPCWSTR
    wintypes.DWORD,  # flags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # bufferLength : DWORD* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # buffer : BYTE* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
PackageIdFromFullName = Fiddle::Function.new(
  lib['PackageIdFromFullName'],
  [
    Fiddle::TYPE_VOIDP,  # packageFullName : LPCWSTR
    -Fiddle::TYPE_INT,  # flags : DWORD
    Fiddle::TYPE_VOIDP,  # bufferLength : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # buffer : BYTE* optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn PackageIdFromFullName(
        packageFullName: *const u16,  // LPCWSTR
        flags: u32,  // DWORD
        bufferLength: *mut u32,  // DWORD* in/out
        buffer: *mut u8  // BYTE* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint PackageIdFromFullName([MarshalAs(UnmanagedType.LPWStr)] string packageFullName, uint flags, ref uint bufferLength, IntPtr buffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PackageIdFromFullName' -Namespace Win32 -PassThru
# $api::PackageIdFromFullName(packageFullName, flags, bufferLength, buffer)

#uselib "KERNEL32.dll"
#func global PackageIdFromFullName "PackageIdFromFullName" sptr, sptr, sptr, sptr
; PackageIdFromFullName packageFullName, flags, varptr(bufferLength), varptr(buffer)   ; 戻り値は stat
; packageFullName : LPCWSTR -> "sptr"
; flags : DWORD -> "sptr"
; bufferLength : DWORD* in/out -> "sptr"
; buffer : BYTE* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global PackageIdFromFullName "PackageIdFromFullName" wstr, int, var, var
; res = PackageIdFromFullName(packageFullName, flags, bufferLength, buffer)
; packageFullName : LPCWSTR -> "wstr"
; flags : DWORD -> "int"
; bufferLength : DWORD* in/out -> "var"
; buffer : BYTE* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global PackageIdFromFullName "PackageIdFromFullName" wstr, int, sptr, sptr
; res = PackageIdFromFullName(packageFullName, flags, varptr(bufferLength), varptr(buffer))
; packageFullName : LPCWSTR -> "wstr"
; flags : DWORD -> "int"
; bufferLength : DWORD* in/out -> "sptr"
; buffer : BYTE* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。