FormatApplicationUserModelId 関数 (appmodel.h)

パッケージ ファミリ名とパッケージ相対アプリケーション ID (PRAID) からアプリケーション ユーザー モデルID を構築します。

構文

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

パラメーター

[in] packageFamilyName

種類: PCWSTR

パッケージ ファミリ名。

[in] packageRelativeApplicationId

種類: PCWSTR

パッケージ相対アプリ ID (PRAID)。

[in, out] applicationUserModelIdLength

種類: UINT32*

アプリ ユーザー モデル ID 文字列内の文字数 (WCHAR) を保持する変数へのポインター。これには null 終端記号が含まれます。

最初に、applicationUserModelId に NULL を渡して文字数を取得します。 この番号を使用して、 applicationUserModelId のメモリ領域を割り当てます。 次に、 applicationUserModelId を埋めるために、このメモリ領域のアドレスを渡します。

[out, optional] applicationUserModelId

種類: PWSTR

null 終端記号を含むアプリ ユーザー モデル ID 文字列を受け取るメモリ領域へのポインター。

戻り値

型: LONG

関数が成功した場合は 、ERROR_SUCCESSを返します。 それ以外の場合、関数はエラー コードを返します。 考えられるエラー コードは次のとおりです。

リターン コード	説明
ERROR_INVALID_PARAMETER	packageFamilyName または packageRelativeApplicationId パラメーターが無効です。
ERROR_INSUFFICIENT_BUFFER	applicationUserModelId で指定されたバッファーは、データを保持するのに十分な大きさではありません。必要なバッファー サイズ (WCHARs) は、applicationUserModelIdLength が指す変数に格納されます。

要件

要件	値
サポートされている最小のクライアント	Windows 8.1 [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows Server 2012 R2 [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	appmodel.h
Library	Kernel32.lib
[DLL]	Kernel32.dll