GetCurrentPackageFamilyName 関数 (appmodel.h)

呼び出し元プロセスのパッケージ ファミリ名を取得します。

構文

LONG GetCurrentPackageFamilyName(
  [in, out]       UINT32 *packageFamilyNameLength,
  [out, optional] PWSTR  packageFamilyName
);

パラメーター

[in, out] packageFamilyNameLength

型: UINT32*

入力時に、 packageFamilyName バッファーのサイズ (null ターミネータを含む文字単位)。 出力時に返されるパッケージ ファミリ名のサイズ (null ターミネータを含む文字単位)。

[out, optional] packageFamilyName

種類: PWSTR

パッケージ ファミリ名。

戻り値

型: LONG

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

リターン コード	説明
APPMODEL_ERROR_NO_PACKAGE	このプロセスにはパッケージ ID がありません。
ERROR_INSUFFICIENT_BUFFER	バッファーは、データを保持するのに十分な大きさではありません。 必要なサイズは packageFamilyNameLength によって指定されます。

注釈

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

例

#define _UNICODE 1
#define UNICODE 1

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

int __cdecl wmain()
{
    UINT32 length = 0;
    LONG rc = GetCurrentPackageFamilyName(&length, NULL);
    if (rc != ERROR_INSUFFICIENT_BUFFER)
    {
        if (rc == APPMODEL_ERROR_NO_PACKAGE)
            wprintf(L"Process has no package identity\n");
        else
            wprintf(L"Error %d in GetCurrentPackageFamilyName\n", rc);
        return 1;
    }

    PWSTR familyName = (PWSTR) malloc(length * sizeof(*familyName));
    if (familyName == NULL)
    {
        wprintf(L"Error allocating memory\n");
        return 2;
    }

    rc = GetCurrentPackageFamilyName(&length, familyName);
    if (rc != ERROR_SUCCESS)
    {
        wprintf(L"Error %d retrieving PackageFamilyName\n", rc);
        return 3;
    }
    wprintf(L"%s\n", familyName);

    free(familyName);

    return 0;
}

要件

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

関連項目

GetCurrentPackageFullName

GetCurrentPackageId

GetCurrentPackageInfo

GetCurrentPackagePath

GetPackageFamilyName

PackageFamilyNameFromFullName

PackageFamilyNameFromId