Função GetCurrentPackageFamilyName (appmodel.h)

Artigo
02/26/2024

Obtém o nome da família de pacotes para o processo de chamada.

Sintaxe

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

Parâmetros

[in, out] packageFamilyNameLength

Tipo: UINT32*

Na entrada, o tamanho do buffer packageFamilyName , em caracteres, incluindo o terminador nulo. Na saída, o tamanho do nome da família de pacotes retornado, em caracteres, incluindo o terminador nulo.

[out, optional] packageFamilyName

Tipo: PWSTR

O nome da família de pacotes.

Retornar valor

Tipo: LONG

Se a função for bem-sucedida, ela retornará ERROR_SUCCESS. Caso contrário, a função retornará um código de erro. Os códigos de erro possíveis incluem o seguinte.

Código de retorno	Descrição
APPMODEL_ERROR_NO_PACKAGE	O processo não tem nenhum identificador de pacote.
ERROR_INSUFFICIENT_BUFFER	O buffer não é grande o suficiente para manter os dados. O tamanho necessário é especificado por packageFamilyNameLength.

Comentários

Para obter informações sobre limites de tamanho de cadeia de caracteres, consulte Constantes de identidade.

Exemplos

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

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 8 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2012 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	appmodel.h
Biblioteca	Kernel32.lib
DLL	Kernel32.dll