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:

Public Member Functions
unsafe void	CopyFile (string originalFilename, string newFilename)
	Copies a file. More...
unsafe void	CreateDirectory (string dirname)
	Creates a directory. More...
unsafe void	DeleteFile (string filename)
	Deletes a file. More...
unsafe bool	FileExists (string testFilename)
	Tests to see that a file exists More...
unsafe bool	IsFileWritable (string filename)
	Returns true if a file exists, and is writable by the NX session. More...
unsafe void	RemoveDirectory (string dirname)
	Deletes a directory. More...
unsafe void	RenameFile (string oldFilename, string newFilename)
	Renames a file. More...
unsafe void	SetFileWritable (string filename, bool writable)
	Sets a file's permissions to be writable by the NX session. More...
Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
override string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...

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 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

Member Function Documentation

unsafe void NXOpen.RemoteUtilities.CopyFile ( string  originalFilename, string  newFilename  )

inline

Copies a file.

Created in NX3.0.0

License requirements: None.

Parameters

originalFilename	Original filename.
newFilename	Newly copied filename.

unsafe void NXOpen.RemoteUtilities.CreateDirectory ( string  dirname )

inline

Creates a directory.

Created in NX3.0.0

License requirements: None.

Parameters

dirname

Name of new directory

unsafe void NXOpen.RemoteUtilities.DeleteFile ( string  filename )

inline

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

filename

File to be deleted.

unsafe bool NXOpen.RemoteUtilities.FileExists ( string  testFilename )

inline

Tests to see that a file exists

Created in NX3.0.0

License requirements: None.

Parameters

testFilename

Filename to query

Returns

True if the file exists

unsafe bool NXOpen.RemoteUtilities.IsFileWritable ( string  filename )

inline

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

Created in NX3.0.0

License requirements: None.

Parameters

filename

File to be checked.

Returns

True if the file exists, and is writable

unsafe void NXOpen.RemoteUtilities.RemoveDirectory ( string  dirname )

inline

Deletes a directory.

Created in NX3.0.0

License requirements: None.

Parameters

dirname

Name of directory to be deleted

unsafe void NXOpen.RemoteUtilities.RenameFile ( string  oldFilename, string  newFilename  )

inline

Renames a file.

Created in NX3.0.0

License requirements: None.

Parameters

oldFilename	Old filename.
newFilename	New filename.

unsafe void NXOpen.RemoteUtilities.SetFileWritable ( string  filename, bool  writable  )

inline

Sets a file's permissions to be writable by the NX session.

Created in NX3.0.0

License requirements: None.

Parameters

filename	File to be checked.
writable	True to make the file writable, false to make it readonly

---

The documentation for this class was generated from the following file:

• RemoteUtilities.cs