FormatApplicationUserModelId-Funktion (appmodel.h)

Erstellt eine Anwendungsbenutzermodell-ID aus dem Paketfamiliennamen und der paketrelativen Anwendungs-ID (PRAID).

Syntax

LONG FormatApplicationUserModelId(
  [in]            PCWSTR packageFamilyName,
  [in]            PCWSTR packageRelativeApplicationId,
  [in, out]       UINT32 *applicationUserModelIdLength,
  [out, optional] PWSTR  applicationUserModelId
);

Parameter

[in] packageFamilyName

Typ: PCWSTR

Der Name der Paketfamilie.

[in] packageRelativeApplicationId

Typ: PCWSTR

Die paketrelative App-ID (PRAID).

[in, out] applicationUserModelIdLength

Typ: UINT32*

Ein Zeiger auf eine Variable, die die Anzahl von Zeichen (WCHARs) in der App-Benutzermodell-ID-Zeichenfolge enthält, die den NULL-Abschlusszeichen enthält.

Zuerst übergeben Sie NULL an applicationUserModelId , um die Anzahl der Zeichen abzurufen. Sie verwenden diese Nummer, um Speicherplatz für applicationUserModelId zuzuweisen. Anschließend übergeben Sie die Adresse dieses Speicherplatzes, um applicationUserModelId zu füllen.

[out, optional] applicationUserModelId

Typ: PWSTR

Ein Zeiger auf den Speicherplatz, der die Zeichenfolge des App-Benutzermodells empfängt, die das NULL-Abschlusszeichen enthält.

Rückgabewert

Typ: LONG

Wenn die Funktion erfolgreich ist, gibt sie ERROR_SUCCESS zurück. Andernfalls gibt die Funktion einen Fehlercode zurück. Folgende Fehlercodes sind möglich.

Rückgabecode Beschreibung
ERROR_INVALID_PARAMETER
Der Parameter packageFamilyName oder packageRelativeApplicationId ist ungültig.
ERROR_INSUFFICIENT_BUFFER
Der von applicationUserModelId angegebene Puffer ist nicht groß genug, um die Daten aufzunehmen. Die erforderliche Puffergröße in WCHARs wird in der Variablen gespeichert, auf die applicationUserModelIdLength verweist.

Anforderungen

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