NX Open C++ Reference Guide
|
Represents operations which can be done on bookmark files. More...
Public Member Functions | |
void | Delete (const NXString &pathName) |
Deletes an existing bookmark file. More... | |
void | Delete (const char *pathName) |
Deletes an existing bookmark file. More... | |
NXString | Rename (const NXString &oldPathName, const NXString &newFileName, bool okToOverwriteExistingFile) |
Renames an existing bookmark file. More... | |
NXString | Rename (const char *oldPathName, const char *newFileName, bool okToOverwriteExistingFile) |
Renames an existing bookmark file. More... | |
void | SaveWithDescription (const NXString &pathName, NXOpen::BasePart::BookmarkOption bookmarkOption, const NXString &description) |
Creates a bookmark file including a description. More... | |
void | SaveWithDescription (const char *pathName, NXOpen::BasePart::BookmarkOption bookmarkOption, const char *description) |
Creates a bookmark file including a description. More... | |
void | SetDescription (const NXString &pathName, const NXString &description) |
Changes the description of an existing bookmark file. More... | |
void | SetDescription (const char *pathName, const char *description) |
Changes the description of an existing bookmark file. More... | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents operations which can be done on bookmark files.
To obtain an instance of this class, refer to NXOpen::Session
Created in NX10.0.0.
void NXOpen::Gateway::BookmarkFile::Delete | ( | const NXString & | pathName | ) |
Deletes an existing bookmark file.
Created in NX10.0.0.
License requirements : None
pathName | Full path name of existing bookmark file to delete |
void NXOpen::Gateway::BookmarkFile::Delete | ( | const char * | pathName | ) |
Deletes an existing bookmark file.
Created in NX10.0.0.
License requirements : None
pathName | Full path name of existing bookmark file to delete |
NXString NXOpen::Gateway::BookmarkFile::Rename | ( | const NXString & | oldPathName, |
const NXString & | newFileName, | ||
bool | okToOverwriteExistingFile | ||
) |
Renames an existing bookmark file.
oldPathName | Full path name of existing bookmark file. |
newFileName | New name to assign to the bookmark file. This will replace the basic name in the oldPathname. |
okToOverwriteExistingFile | Is it okay to overwrite an existing file with the same name as oldPathName plus newFileName? |
NXString NXOpen::Gateway::BookmarkFile::Rename | ( | const char * | oldPathName, |
const char * | newFileName, | ||
bool | okToOverwriteExistingFile | ||
) |
Renames an existing bookmark file.
oldPathName | Full path name of existing bookmark file. |
newFileName | New name to assign to the bookmark file. This will replace the basic name in the oldPathname. |
okToOverwriteExistingFile | Is it okay to overwrite an existing file with the same name as oldPathName plus newFileName? |
void NXOpen::Gateway::BookmarkFile::SaveWithDescription | ( | const NXString & | pathName, |
NXOpen::BasePart::BookmarkOption | bookmarkOption, | ||
const NXString & | description | ||
) |
Creates a bookmark file including a description.
See NXOpen::BasePart::BookmarkOption for an explanation of the options which are not supported in batch mode. Also in batch mode, the description is not written to the bookmark file.
Created in NX10.0.0.
License requirements : None
pathName | Full path name of bookmark file. |
bookmarkOption | See definitions of NXOpen::BasePart::BookmarkOption |
description | A text string to be stored in the bookmark file |
void NXOpen::Gateway::BookmarkFile::SaveWithDescription | ( | const char * | pathName, |
NXOpen::BasePart::BookmarkOption | bookmarkOption, | ||
const char * | description | ||
) |
Creates a bookmark file including a description.
See NXOpen::BasePart::BookmarkOption for an explanation of the options which are not supported in batch mode. Also in batch mode, the description is not written to the bookmark file.
Created in NX10.0.0.
License requirements : None
pathName | Full path name of bookmark file. |
bookmarkOption | See definitions of NXOpen::BasePart::BookmarkOption |
description | A text string to be stored in the bookmark file |
void NXOpen::Gateway::BookmarkFile::SetDescription | ( | const NXString & | pathName, |
const NXString & | description | ||
) |
Changes the description of an existing bookmark file.
Otherwise the bookmark file is unchanged.
Created in NX10.0.0.
License requirements : None
pathName | Full path name of an existing bookmark file. |
description | A text string to replace the current description in the bookmark file |
void NXOpen::Gateway::BookmarkFile::SetDescription | ( | const char * | pathName, |
const char * | description | ||
) |
Changes the description of an existing bookmark file.
Otherwise the bookmark file is unchanged.
Created in NX10.0.0.
License requirements : None
pathName | Full path name of an existing bookmark file. |
description | A text string to replace the current description in the bookmark file |
tag_t NXOpen::Gateway::BookmarkFile::Tag | ( | ) | const |
Returns the tag of this object.