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
void	CopyFile (const NXString &originalFilename, const NXString &newFilename)
	Copies a file.

void	CopyFile (const char originalFilename, const char newFilename)
	Copies a file.

void	CreateDirectory (const NXString &dirname)
	Creates a directory.

void	CreateDirectory (const char *dirname)
	Creates a directory.

void	DeleteFile (const NXString &filename)
	Deletes a file.

void	DeleteFile (const char *filename)
	Deletes a file.

bool	FileExists (const NXString &testFilename)
	Tests to see that a file exists.

bool	FileExists (const char *testFilename)
	Tests to see that a file exists.

NXString	GetEnvironmentVariable (const NXString &variableName)
	Gets the value of an environment variable.

NXString	GetEnvironmentVariable (const char *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.

bool	IsFileWritable (const char *filename)
	Returns true if a file exists, and is writable by the NX session.

void	RemoveDirectory (const NXString &dirname)
	Deletes a directory.

void	RemoveDirectory (const char *dirname)
	Deletes a directory.

void	RenameFile (const NXString &oldFilename, const NXString &newFilename)
	Renames a file.

void	RenameFile (const char oldFilename, const char newFilename)
	Renames a file.

void	SetFileWritable (const NXString &filename, bool writable)
	Sets a file's permissions to be writable by the NX session.

void	SetFileWritable (const char *filename, bool writable)
	Sets a file's permissions to be writable by the NX session.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Static Public Member Functions
static RemoteUtilities *	GetRemoteUtilities ()

Detailed Description

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

<br>

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

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::CopyFile	(	const char *	originalFilename,
		const char *	newFilename
	)

Copies a file.

Created in NX3.0.0.

License requirements : None

Parameters

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

Parameters

dirname Name of new directory
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::RemoteUtilities::CreateDirectory ( const char * dirname )

Creates a directory.

Created in NX3.0.0.

License requirements : None

Parameters

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

Parameters

filename File to be deleted.
NOTE: The full Unicode character set is not supported for this parameter.

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

Parameters

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.

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

License requirements : None

Parameters

testFilename Filename to query
NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::RemoteUtilities::FileExists ( const char * testFilename )

Tests to see that a file exists.

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

License requirements : None

Parameters

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.

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

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

NXString NXOpen::RemoteUtilities::GetEnvironmentVariable ( const char * variableName )

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

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.

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

License requirements : None

Parameters

filename File to be checked.
NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::RemoteUtilities::IsFileWritable ( const char * filename )

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

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

Parameters

dirname Name of directory to be deleted
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::RemoteUtilities::RemoveDirectory ( const char * dirname )

Deletes a directory.

Created in NX3.0.0.

License requirements : None

Parameters

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

Parameters

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::RenameFile	(	const char *	oldFilename,
		const char *	newFilename
	)

Renames a file.

Created in NX3.0.0.

License requirements : None

Parameters

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

Parameters

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

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

Parameters

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

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

RemoteUtilities.hxx

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation