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 によると、名前で渡される文字列は有効な名前ではありません。

注釈

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

nameNULL ポインターを渡して 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

こちらもご覧ください

IXpsOMVisual

XML Paper Specification

XPS ドキュメント エラー