Edit

IAppxManifestPackageId::GetPackageFamilyName method (appxpackaging.h)

  • Article

Gets the package family name.

Syntax

HRESULT GetPackageFamilyName(
  [out, retval] LPWSTR *packageFamilyName
);

Parameters

[out, retval] packageFamilyName

Type: LPWSTR*

The package family name.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK.

Remarks

The package family name is a case-insensitive string, which can be used to uniquely identify a family of packages with the same name and publisher.

This string is a serialized form of the package ID, and it is suitable for naming objects such as files and directories. Because the package family name does not contain information about package version, architecture, or resources, it is useful when you need a version-independent reference to a package.

The caller must free the memory for packageFamilyName using the CoTaskMemFree function.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header appxpackaging.h

See also

IAppxManifestPackageId