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

このページの Name プロパティを設定します。

構文

HRESULT SetName(
  [in] LPCWSTR name
);

[in] name

ページの Name プロパティとして設定する名前文字列へのポインター。 NULL ポインターは、以前に割り当てられた名前をクリアします。

このメソッドは HRESULT を返します。使用可能な値には、次の表に含まれる値が含まれますが、これらに限定されません。この表に記載されていない XPS ドキュメント API の戻り値については、「 XPS ドキュメントエラー」を参照してください。

リターンコード	説明
S_OK	メソッドが成功しました。
XPS_E_INVALID_NAME	名前文字列に無効な文字が含まれています。

Name プロパティは、現在のページを文書内の名前付きのアドレス指定可能なポイントとして識別し、ハイパーリンクでページを参照できるようにします。

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