PackageIdFromFullName 関数 (appmodel.h)

指定したパッケージの完全名のパッケージ識別子 (ID) を取得します。

構文

LONG PackageIdFromFullName(
  [in]            PCWSTR       packageFullName,
  [in]            const UINT32 flags,
  [in, out]       UINT32       *bufferLength,
  [out, optional] BYTE         *buffer
);

パラメーター

[in] packageFullName

種類: PCWSTR

パッケージの完全な名前。

[in] flags

型: const UINT32

パッケージ情報の取得方法を指定するパッケージ定数。 PACKAGE_INFORMATION_* フラグがサポートされています。

[in, out] bufferLength

型: UINT32*

入力時の バッファーのサイズ (バイト単位)。 出力時に返されるデータのサイズ (バイト単位)。

[out, optional] buffer

型: BYTE*

PACKAGE_ID構造体として表されるパッケージ ID。

戻り値

型: LONG

関数が成功すると、 ERROR_SUCCESSが返されます。 それ以外の場合、関数はエラー コードを返します。 考えられるエラー コードは次のとおりです。

リターン コード	説明
ERROR_INSUFFICIENT_BUFFER	バッファーは、データを保持するのに十分な大きさではありません。 必要なサイズは bufferLength によって指定されます。
ERROR_NOT_FOUND	パッケージはユーザーに対してインストールされていません。

注釈

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を返します。

文字列サイズの制限については、「 ID 定数」を参照してください。

例

#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);
}

要件

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	appmodel.h
Library	Kernel32.lib
[DLL]	Kernel32.dll

関連項目

GetCurrentPackageId

GetPackageId

PackageFamilyNameFromFullName

PackageFamilyNameFromId

PackageFullNameFromId

PackageNameAndPublisherIdFromFamilyName