NX Open C++ Reference Guide
Public Member Functions | Static Public Member Functions
NXOpen::RemoteUtilities Class Reference

This class is primarily designed for use in a remote session, and allows client applications to access resources on a remote server. More...

Inheritance diagram for NXOpen::RemoteUtilities:
NXOpen::TaggedObject

List of all members.

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 RemoteUtilitiesGetRemoteUtilities ()

Detailed Description

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.


Member Function Documentation

void NXOpen::RemoteUtilities::CopyFile ( const NXString originalFilename,
const NXString newFilename 
)

Copies a file.


Created in NX3.0.0.

License requirements : None

Parameters:
originalFilenameOriginal filename.
NOTE: The full Unicode character set is not supported for this parameter.
newFilenameNewly copied filename.
NOTE: The full Unicode character set is not supported for this parameter.

Creates a directory.


Created in NX3.0.0.

License requirements : None

Parameters:
dirnameName 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

Parameters:
filenameFile 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.

Returns:
True if the file exists
Created in NX3.0.0.

License requirements : None
Parameters:
testFilenameFilename to query
NOTE: The full Unicode character set is not supported for this parameter.

Gets the value of an environment variable.

Returns:
The value of the variable.
Deprecated:
Deprecated in NX8.0.0. Use Session.GetEnvironmentVariable instead.


Created in NX3.0.0.

License requirements : None

Parameters:
variableNameThe environment variable
NOTE: The full Unicode character set is not supported for this parameter.

Returns true if a file exists, and is writable by the NX session.

Returns:
True if the file exists, and is writable
Created in NX3.0.0.

License requirements : None
Parameters:
filenameFile to be checked.
NOTE: The full Unicode character set is not supported for this parameter.

Deletes a directory.


Created in NX3.0.0.

License requirements : None

Parameters:
dirnameName 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

Parameters:
oldFilenameOld filename.
NOTE: The full Unicode character set is not supported for this parameter.
newFilenameNew 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

Parameters:
filenameFile to be checked.
NOTE: The full Unicode character set is not supported for this parameter.
writableTrue to make the file writable, false to make it readonly

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.