GetCurrentPackageFamilyName-Funktion (appmodel.h)

Artikel
02/23/2024

Ruft den Paketfamiliennamen für den aufrufenden Prozess ab.

Syntax

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

Parameter

[in, out] packageFamilyNameLength

Typ: UINT32*

Bei der Eingabe die Größe des PackageFamilyName-Puffers in Zeichen, einschließlich des NULL-Abschlussators. Bei der Ausgabe wird die Größe des zurückgegebenen Paketfamiliennamens in Zeichen, einschließlich des NULL-Abschlussators, zurückgegeben.

[out, optional] packageFamilyName

Typ: PWSTR

Der Paketfamilienname.

Rückgabewert

Typ: LONG

Wenn die Funktion erfolgreich ist, gibt sie ERROR_SUCCESS zurück. Andernfalls gibt die Funktion einen Fehlercode zurück. Zu den möglichen Fehlercodes gehören die folgenden:

Rückgabecode	Beschreibung
APPMODEL_ERROR_NO_PACKAGE	Der Prozess verfügt über keine Paketidentität.
ERROR_INSUFFICIENT_BUFFER	Der Puffer ist nicht groß genug, um die Daten aufzunehmen. Die erforderliche Größe wird von packageFamilyNameLength angegeben.

Hinweise

Informationen zu Zeichenfolgengrößenbeschränkungen finden Sie unter Identitätskonstanten.

Beispiele

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

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	appmodel.h
Bibliothek	Kernel32.lib
DLL	Kernel32.dll