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

ビジュアルの Name プロパティを設定します。

構文

HRESULT SetName(
  [in] LPCWSTR name
);

[in] name

ビジュアルの名前。 NULL ポインターは Name プロパティをクリアします。

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

リターンコード	説明
S_OK	メソッドが成功しました。
XPS_E_INVALID_NAME	XML Paper Specification によると、名前で渡される文字列は有効な名前ではありません。

名前は一意である必要があります。

name に NULL ポインターを渡して Name プロパティをクリアすると、IsHyperlinkTarget プロパティが FALSE に設定されます。


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