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	RenameFile (string oldFilename, string newFilename)
	Renames a file. More...

unsafe void	CopyFile (string originalFilename, string newFilename)
	Copies a file. More...

unsafe bool	FileExists (string testFilename)
	Tests to see that a file exists More...

unsafe void	DeleteFile (string filename)
	Deletes a file. More...

unsafe bool	IsFileWritable (string filename)
	Returns true if a file exists, and is writable by the NX session. More...

unsafe void	SetFileWritable (string filename, bool writable)
	Sets a file's permissions to be writable by the NX session. More...

unsafe void	CreateDirectory (string dirname)
	Creates a directory. More...

unsafe void	RemoveDirectory (string dirname)
	Deletes a directory. More...

unsafe string	GetEnvironmentVariable (string variableName)
	Gets the value of an environment variable. 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
	)

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 )

Creates a directory.

Created in NX3.0.0

License requirements: None.

Parameters

dirname Name of new directory

unsafe void NXOpen.RemoteUtilities.DeleteFile ( string 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

filename File to be deleted.

unsafe bool NXOpen.RemoteUtilities.FileExists ( string testFilename )

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 string NXOpen.RemoteUtilities.GetEnvironmentVariable ( string variableName )

Gets the value of an environment variable.

Created in NX3.0.0

Deprecated in NX8.0.0. Use Session.GetEnvironmentVariable instead.

License requirements: None.

Parameters

variableName The environment variable

Returns: The value of the variable.

unsafe bool NXOpen.RemoteUtilities.IsFileWritable ( string filename )

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 )

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
	)

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
	)

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:

dotnet_pool/RemoteUtilities.cs

Public Member Functions

Detailed Description

Member Function Documentation