IXpsOMPage::GenerateUnusedLookupKey メソッド (xpsobjectmodel.h)

リソースディクショナリ内のリソースによって参照キーとして使用できる一意の名前を生成します。

構文

HRESULT GenerateUnusedLookupKey(
  [in]          XPS_OBJECT_TYPE type,
  [out, retval] LPWSTR          *key
);

[in] type

参照キーが生成される IXpsOMShareable オブジェクトの型。

[out, retval] key

このメソッドによって生成される参照キー文字列。

メソッドが成功すると、S_OKが返されます。それ以外の場合は、 HRESULT エラーコードを返します。

ディクショナリ内で一意であるために、 GenerateUnusedLookupKey によって生成される文字列は、オブジェクトの種類に基づくプレフィックス文字列で構成され、その後に 4 つの一意の英数字が続きます。

次の表に、各オブジェクトの種類のプレフィックス文字列を示します。

オブジェクトの種類	このオブジェクト型のプレフィックス文字列
XPS_OBJECT_TYPE_CANVAS	キャンバス_
XPS_OBJECT_TYPE_GEOMETRY	ジオメトリ_
XPS_OBJECT_TYPE_GLYPHS	グリフ_
XPS_OBJECT_TYPE_IMAGE_BRUSH	IBrush_
XPS_OBJECT_TYPE_LINEAR_GRADIENT_BRUSH	LGBrush_
XPS_OBJECT_TYPE_MATRIX_TRANSFORM	MTransform_
XPS_OBJECT_TYPE_PATH	パス_
XPS_OBJECT_TYPE_RADIAL_GRADIENT_BRUSH	RGBrush_
XPS_OBJECT_TYPE_SOLID_COLOR_BRUSH	SCBrush_
XPS_OBJECT_TYPE_VISUAL_BRUSH	VBrush_

注

このメソッドは、このページのコンテキスト内で一意のキー文字列を返します。複数のページで使用できるリモートディクショナリリソースで一意のキーを返す保証はありません。

このメソッドは、キーで返される文字列で使用されるメモリを割り当てます。 key が NULL でない場合は、CoTaskMemFree 関数を使用してメモリを解放します。


サポートされている最小のクライアント	Windows 7、Windows Vista SP2 と Windows Vista 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	xpsobjectmodel.h