PackageFamilyNameFromFullName function (appmodel.h)

Gets the package family name for the specified package full name.

Syntax

LONG PackageFamilyNameFromFullName(
 [in] PCWSTR packageFullName,
 [in, out] UINT32 *packageFamilyNameLength,
 [out, optional] PWSTR packageFamilyName
);

Parameters

[in] packageFullName

Type: PCWSTR

The full name of a package.

[in, out] packageFamilyNameLength

Type: UINT32*

On input, the size of the packageFamilyName buffer, in characters. On output, the size of the package family name returned, in characters, including the null terminator.

[out, optional] packageFamilyName

Type: PWSTR

The package family name.

Return value

Type: LONG

If the function succeeds it returns ERROR_SUCCESS. Otherwise, the function returns an error code. The possible error codes include the following.

Remarks

For info about string size limits, see Identity constants.

Examples

#define _UNICODE 1
#define UNICODE 1

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

int ShowUsage();
void FullNameToFamilyName(__in PCWSTR fullName);

int ShowUsage()
{
 wprintf(L"Usage: PackageFamilyNameFromFullName <fullname> [<fullname>...]\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)
 FullNameToFamilyName(argv[i]);

 return 0;
}

void FullNameToFamilyName(__in PCWSTR fullName)
{
 wprintf(L"FullName: %s\n", fullName);
 UINT32 length = 0;
 LONG rc = PackageFamilyNameFromFullName(fullName, &length, NULL);
 if (rc == ERROR_SUCCESS)
 {
 wprintf(L"PackageFamilyNameFromFullName unexpectedly succeeded\n");
 return;
 }
 else if (rc != ERROR_INSUFFICIENT_BUFFER)
 {
 wprintf(L"Error %d in PackageFamilyNameFromFullName\n", rc);
 return;
 }

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

 rc = PackageFamilyNameFromFullName(fullName, &length, familyName);
 if (rc != ERROR_SUCCESS)
 wprintf(L"Error %d converting PackageFamilyName to FullName\n", rc);
 else
 wprintf(L"Package Family Name = %s\n", familyName);

 free(familyName);
}

Requirements

See also

GetCurrentPackageFamilyName

GetPackageFamilyName

PackageFamilyNameFromId

PackageFullNameFromId

PackageIdFromFullName

PackageNameAndPublisherIdFromFamilyName