NX Open C++ Reference Guide
|
This class is primarily designed for use in a remote session, and allows client applications to access resources on a remote server. More...
Public Member Functions | |
void | CopyFile (const NXString &originalFilename, const NXString &newFilename) |
Copies a file. More... | |
void | CopyFile (const char *originalFilename, const char *newFilename) |
Copies a file. More... | |
void | CreateDirectory (const NXString &dirname) |
Creates a directory. More... | |
void | CreateDirectory (const char *dirname) |
Creates a directory. More... | |
void | DeleteFile (const NXString &filename) |
Deletes a file. More... | |
void | DeleteFile (const char *filename) |
Deletes a file. More... | |
bool | FileExists (const NXString &testFilename) |
Tests to see that a file exists. More... | |
bool | FileExists (const char *testFilename) |
Tests to see that a file exists. More... | |
NXString | GetEnvironmentVariable (const NXString &variableName) |
Gets the value of an environment variable. More... | |
NXString | GetEnvironmentVariable (const char *variableName) |
Gets the value of an environment variable. More... | |
bool | IsFileWritable (const NXString &filename) |
Returns true if a file exists, and is writable by the NX session. More... | |
bool | IsFileWritable (const char *filename) |
Returns true if a file exists, and is writable by the NX session. More... | |
void | RemoveDirectory (const NXString &dirname) |
Deletes a directory. More... | |
void | RemoveDirectory (const char *dirname) |
Deletes a directory. More... | |
void | RenameFile (const NXString &oldFilename, const NXString &newFilename) |
Renames a file. More... | |
void | RenameFile (const char *oldFilename, const char *newFilename) |
Renames a file. More... | |
void | SetFileWritable (const NXString &filename, bool writable) |
Sets a file's permissions to be writable by the NX session. More... | |
void | SetFileWritable (const char *filename, bool writable) |
Sets a file's permissions to be writable by the NX session. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Static Public Member Functions | |
static RemoteUtilities * | GetRemoteUtilities () |
This class is primarily designed for use in a remote session, and allows client applications to access resources on a remote server.
Note that due to security considerations, this class is independent of the main NXOpen::Session . The server must explicitly export a RemoteUtilities object in order to allow clients to access the methods in this class. Application writers should be aware that this class will allow clients to delete and modify files on the server.
To obtain an instance of this class use NXOpen::RemoteUtilities::GetRemoteUtilities
Created in NX3.0.0.
void NXOpen::RemoteUtilities::CopyFile | ( | const NXString & | originalFilename, |
const NXString & | newFilename | ||
) |
Copies a file.
Created in NX3.0.0.
License requirements : None
originalFilename | Original filename. |
newFilename | Newly copied filename. |
void NXOpen::RemoteUtilities::CopyFile | ( | const char * | originalFilename, |
const char * | newFilename | ||
) |
Copies a file.
Created in NX3.0.0.
License requirements : None
originalFilename | Original filename. |
newFilename | Newly copied filename. |
void NXOpen::RemoteUtilities::CreateDirectory | ( | const NXString & | dirname | ) |
Creates a directory.
Created in NX3.0.0.
License requirements : None
dirname | Name of new directory |
void NXOpen::RemoteUtilities::CreateDirectory | ( | const char * | dirname | ) |
Creates a directory.
Created in NX3.0.0.
License requirements : None
dirname | Name of new directory |
void NXOpen::RemoteUtilities::DeleteFile | ( | const NXString & | filename | ) |
Deletes a file.
Note that if the file does not exist, this method returns without any errors.
Created in NX3.0.0.
License requirements : None
filename | File to be deleted. |
void NXOpen::RemoteUtilities::DeleteFile | ( | const char * | filename | ) |
Deletes a file.
Note that if the file does not exist, this method returns without any errors.
Created in NX3.0.0.
License requirements : None
filename | File to be deleted. |
bool NXOpen::RemoteUtilities::FileExists | ( | const NXString & | testFilename | ) |
Tests to see that a file exists.
testFilename | Filename to query |
bool NXOpen::RemoteUtilities::FileExists | ( | const char * | testFilename | ) |
Tests to see that a file exists.
testFilename | Filename to query |
Gets the value of an environment variable.
Created in NX3.0.0.
License requirements : None
variableName | The environment variable |
NXString NXOpen::RemoteUtilities::GetEnvironmentVariable | ( | const char * | variableName | ) |
Gets the value of an environment variable.
Created in NX3.0.0.
License requirements : None
variableName | The environment variable |
bool NXOpen::RemoteUtilities::IsFileWritable | ( | const NXString & | filename | ) |
Returns true if a file exists, and is writable by the NX session.
filename | File to be checked. |
bool NXOpen::RemoteUtilities::IsFileWritable | ( | const char * | filename | ) |
Returns true if a file exists, and is writable by the NX session.
filename | File to be checked. |
void NXOpen::RemoteUtilities::RemoveDirectory | ( | const NXString & | dirname | ) |
Deletes a directory.
Created in NX3.0.0.
License requirements : None
dirname | Name of directory to be deleted |
void NXOpen::RemoteUtilities::RemoveDirectory | ( | const char * | dirname | ) |
Deletes a directory.
Created in NX3.0.0.
License requirements : None
dirname | Name of directory to be deleted |
void NXOpen::RemoteUtilities::RenameFile | ( | const NXString & | oldFilename, |
const NXString & | newFilename | ||
) |
Renames a file.
Created in NX3.0.0.
License requirements : None
oldFilename | Old filename. |
newFilename | New filename. |
void NXOpen::RemoteUtilities::RenameFile | ( | const char * | oldFilename, |
const char * | newFilename | ||
) |
Renames a file.
Created in NX3.0.0.
License requirements : None
oldFilename | Old filename. |
newFilename | New filename. |
void NXOpen::RemoteUtilities::SetFileWritable | ( | const NXString & | filename, |
bool | writable | ||
) |
Sets a file's permissions to be writable by the NX session.
Created in NX3.0.0.
License requirements : None
filename | File to be checked. |
writable | True to make the file writable, false to make it readonly |
void NXOpen::RemoteUtilities::SetFileWritable | ( | const char * | filename, |
bool | writable | ||
) |
Sets a file's permissions to be writable by the NX session.
Created in NX3.0.0.
License requirements : None
filename | File to be checked. |
writable | True to make the file writable, false to make it readonly |