GetPackageFamilyNameFromToken function
Gets the package family name for the specified token.
Syntax
LONG WINAPI GetPackageFamilyNameFromToken( _In_ HANDLE token, _Inout_ UINT32 *packageFamilyNameLength, _Out_opt_ PWSTR packageFamilyName );
Parameters
- token [in]
-
Type: HANDLE
A token that contains the package identity.
- packageFamilyNameLength [in, out]
-
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.
- packageFamilyName [out, optional]
-
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.
| Return code | Description |
|---|---|
|
The token has no package identity. |
|
The buffer is not large enough to hold the data. The required size is specified by packageFamilyNameLength. |
Remarks
For info about string size limits, see Identity constants.
Examples
/*************************************************** * * * Copyright (C) Microsoft. All rights reserved. * * * ***************************************************/ #define _UNICODE 1 #define UNICODE 1 #include <Windows.h> #include <appmodel.h> #include <appmodelp.h> #include <malloc.h> #include <stdlib.h> #include <stdio.h> int ShowUsage(); void ShowProcessPackageFamilyName(__in const UINT32 pid, __in HANDLE token); int ShowUsage() { wprintf(L"Usage: GetPackageFamilyNameFromToken <pid> [<pid>...]\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) { UINT32 pid = wcstoul(argv[i], NULL, 10); if (pid > 0) { HANDLE process = OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION, FALSE, pid); if (process == NULL) wprintf(L"Error %d in OpenProcess (pid=%u)\n", GetLastError(), pid); else { HANDLE token; if (!OpenProcessToken(process, TOKEN_QUERY, &token)) wprintf(L"Error %d in OpenProcessToken (pid=%u)\n", GetLastError(), pid); else { ShowProcessPackageFamilyName(pid, token); CloseHandle(token); } CloseHandle(process); } } } return 0; } void ShowProcessPackageFamilyName(__in const UINT32 pid, __in HANDLE token) { wprintf(L"Process %u (token=%p)\n", pid, token); UINT32 length = 0; LONG rc = GetPackageFamilyNameFromToken(token, &length, NULL); if (rc != ERROR_INSUFFICIENT_BUFFER) { if (rc == APPMODEL_ERROR_NO_PACKAGE) wprintf(L"Token has no package identity\n"); else wprintf(L"Error %d in GetPackageFamilyNameFromToken\n", rc); return; } PWSTR familyName = (PWSTR) malloc(length * sizeof(*familyName)); if (familyName == NULL) { wprintf(L"Error allocating memory\n"); return; } rc = GetPackageFamilyNameFromToken(token, &length, familyName); if (rc != ERROR_SUCCESS) wprintf(L"Error %d retrieving PackageFamilyName\n", rc); else wprintf(L"%s\n", familyName); free(familyName); }
Requirements
|
Minimum supported client |
Windows 8 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2012 [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|