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. | |
void | CreateDirectory (const NXString &dirname) |
Creates a directory. | |
void | DeleteFile (const NXString &filename) |
Deletes a file. | |
bool | FileExists (const NXString &testFilename) |
Tests to see that a file exists. | |
NXString | GetEnvironmentVariable (const NXString &variableName) |
Gets the value of an environment variable. | |
bool | IsFileWritable (const NXString &filename) |
Returns true if a file exists, and is writable by the NX session. | |
void | RemoveDirectory (const NXString &dirname) |
Deletes a directory. | |
void | RenameFile (const NXString &oldFilename, const NXString &newFilename) |
Renames a file. | |
void | SetFileWritable (const NXString &filename, bool writable) |
Sets a file's permissions to be writable by the NX session. | |
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 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 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. NOTE: The full Unicode character set is not supported for this parameter. |
newFilename | Newly copied filename. NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::RemoteUtilities::CreateDirectory | ( | const NXString & | dirname | ) |
Creates a directory.
Created in NX3.0.0.
License requirements : None
dirname | Name of new directory NOTE: The full Unicode character set is not supported for this parameter. |
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. NOTE: The full Unicode character set is not supported for this parameter. |
bool NXOpen::RemoteUtilities::FileExists | ( | const NXString & | testFilename | ) |
Tests to see that a file exists.
testFilename | Filename to query NOTE: The full Unicode character set is not supported for this parameter. |
NXString NXOpen::RemoteUtilities::GetEnvironmentVariable | ( | const NXString & | variableName | ) |
Gets the value of an environment variable.
Created in NX3.0.0.
License requirements : None
variableName | The environment variable NOTE: The full Unicode character set is not supported for this parameter. |
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. NOTE: The full Unicode character set is not supported for this parameter. |
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 NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::RemoteUtilities::RenameFile | ( | const NXString & | oldFilename, |
const NXString & | newFilename | ||
) |
Renames a file.
Created in NX3.0.0.
License requirements : None
oldFilename | Old filename. NOTE: The full Unicode character set is not supported for this parameter. |
newFilename | New filename. NOTE: The full Unicode character set is not supported for this parameter. |
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. NOTE: The full Unicode character set is not supported for this parameter. |
writable | True to make the file writable, false to make it readonly |