NXOpen::Gateway::BookmarkFile类 参考

书签文件 更多...

#include <Gateway_BookmarkFile.hxx>

Public 成员函数
void	Delete (const char *pathName)
void	Delete (const NXString &pathName)
NXString	Rename (const char *oldPathName, const char *newFileName, bool okToOverwriteExistingFile)
NXString	Rename (const NXString &oldPathName, const NXString &newFileName, bool okToOverwriteExistingFile)
void	SaveWithDescription (const char *pathName, NXOpen::BasePart::BookmarkOption bookmarkOption, const char *description)
void	SaveWithDescription (const NXString &pathName, NXOpen::BasePart::BookmarkOption bookmarkOption, const NXString &description)
void	SetDescription (const char *pathName, const char *description)
void	SetDescription (const NXString &pathName, const NXString &description)
tag_t	Tag () const

详细描述

书签文件

表示可对书签文件执行的操作。
要获取此类的实例，请参考 NXOpen::Session

创建于NX10.0.0。

成员函数说明

Delete() [1/2]

void NXOpen::Gateway::BookmarkFile::Delete

(

const char *

pathName

)

删除现有书签文件。
创建于NX10.0.0。

许可证要求：无

参数

pathName

要删除的现有书签文件的完整路径名

Delete() [2/2]

void NXOpen::Gateway::BookmarkFile::Delete

(

const NXString &

pathName

)

删除现有书签文件。
创建于NX10.0.0。

许可证要求：无

参数

pathName

要删除的现有书签文件的完整路径名

Rename() [1/2]

NXString NXOpen::Gateway::BookmarkFile::Rename	(	const char *	oldPathName,
		const char *	newFileName,
		bool	okToOverwriteExistingFile )

重命名现有书签文件。

返回

重命名后的书签文件完整路径名。 该文本字符串必须由调用者释放。
创建于NX10.0.0。

许可证要求：无

参数

oldPathName	现有书签文件的完整路径名。
newFileName	要分配给书签文件的新名称。 它将替换旧路径名中的基本名称。
okToOverwriteExistingFile	是否可以覆盖与旧路径名加上新文件名相同的现有文件？

Rename() [2/2]

NXString NXOpen::Gateway::BookmarkFile::Rename	(	const NXString &	oldPathName,
		const NXString &	newFileName,
		bool	okToOverwriteExistingFile )

重命名现有书签文件。

返回

重命名后的书签文件完整路径名。 该文本字符串必须由调用者释放。
创建于NX10.0.0。

许可证要求：无

参数

oldPathName	现有书签文件的完整路径名。
newFileName	要分配给书签文件的新名称。 它将替换旧路径名中的基本名称。
okToOverwriteExistingFile	是否可以覆盖与旧路径名加上新文件名相同的现有文件？

SaveWithDescription() [1/2]

void NXOpen::Gateway::BookmarkFile::SaveWithDescription	(	const char *	pathName,
		NXOpen::BasePart::BookmarkOption	bookmarkOption,
		const char *	description )

创建包含描述的书签文件。 有关批处理模式下不支持的选项的说明，请参见 NXOpen::BasePart::BookmarkOption 。 在批处理模式下，描述也不会写入书签文件。
创建于NX10.0.0。

许可证要求：无

参数

pathName	书签文件的完整路径名。
bookmarkOption	有关定义，请参见 NXOpen::BasePart::BookmarkOption
description	要存储在书签文件中的文本字符串

SaveWithDescription() [2/2]

void NXOpen::Gateway::BookmarkFile::SaveWithDescription	(	const NXString &	pathName,
		NXOpen::BasePart::BookmarkOption	bookmarkOption,
		const NXString &	description )

创建包含描述的书签文件。 有关批处理模式下不支持的选项的说明，请参见 NXOpen::BasePart::BookmarkOption 。 在批处理模式下，描述也不会写入书签文件。
创建于NX10.0.0。

许可证要求：无

参数

pathName	书签文件的完整路径名。
bookmarkOption	有关定义，请参见 NXOpen::BasePart::BookmarkOption
description	要存储在书签文件中的文本字符串

SetDescription() [1/2]

void NXOpen::Gateway::BookmarkFile::SetDescription	(	const char *	pathName,
		const char *	description )

更改现有书签文件的描述。否则，书签文件保持不变。
创建于NX10.0.0。

许可证要求：无

参数

pathName	现有书签文件的完整路径名。
description	替换书签文件中当前描述的文本字符串

SetDescription() [2/2]

void NXOpen::Gateway::BookmarkFile::SetDescription	(	const NXString &	pathName,
		const NXString &	description )

更改现有书签文件的描述。否则，书签文件保持不变。
创建于NX10.0.0。

许可证要求：无

参数

pathName	现有书签文件的完整路径名。
description	替换书签文件中当前描述的文本字符串

Tag()

tag_t NXOpen::Gateway::BookmarkFile::Tag

(

)

const

获取此对象的标签。