NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PDM::PersistentSettings Class Reference

Persistently held settings for a Teamcenter user account. More...

Inheritance diagram for NXOpen::PDM::PersistentSettings:
NXOpen::TransientObject

Public Member Functions

void Apply ()
 Applies any changes to the settings
Created in NX4.0.0. More...
 
std::vector< NXStringGetGroups ()
 Gets the names of the Teamcenter groups to which the user belongs. More...
 
std::vector< NXStringGetVolumes ()
 Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM::PersistentSettings::GetGroups . More...
 
NXString Group ()
 Returns the Teamcenter group in which the user acts by default. More...
 
void SetGroup (const NXString &group)
 Sets the Teamcenter group in which the user acts by default. More...
 
void SetGroup (const char *group)
 Sets the Teamcenter group in which the user acts by default. More...
 
void SetVolume (const NXString &volume)
 Sets the Teamcenter volume to which the user used by default. More...
 
void SetVolume (const char *volume)
 Sets the Teamcenter volume to which the user used by default. More...
 
NXString Volume ()
 Returns the Teamcenter volume to which the user used by default. More...
 
virtual ~PersistentSettings ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Persistently held settings for a Teamcenter user account.

Any changes will only take effect when PDM::PersistentSettings::Apply is callsed.
Created in NX4.0.0.

Constructor & Destructor Documentation

virtual NXOpen::PDM::PersistentSettings::~PersistentSettings ( )
virtual

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX4.0.0.

License requirements : None

Member Function Documentation

void NXOpen::PDM::PersistentSettings::Apply ( )

Applies any changes to the settings
Created in NX4.0.0.



License requirements : None

std::vector<NXString> NXOpen::PDM::PersistentSettings::GetGroups ( )

Gets the names of the Teamcenter groups to which the user belongs.

Returns
the names of the groups
Created in NX4.0.0.

License requirements : None
std::vector<NXString> NXOpen::PDM::PersistentSettings::GetVolumes ( )

Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM::PersistentSettings::GetGroups .

Returns
the names of the volumes
Created in NX4.0.0.

License requirements : None
NXString NXOpen::PDM::PersistentSettings::Group ( )

Returns the Teamcenter group in which the user acts by default.

Should be one of those given by PDM::PersistentSettings::GetGroups


Created in NX4.0.0.

License requirements : None

void NXOpen::PDM::PersistentSettings::SetGroup ( const NXString group)

Sets the Teamcenter group in which the user acts by default.

Should be one of those given by PDM::PersistentSettings::GetGroups


Created in NX4.0.0.

License requirements : None

Parameters
groupgroup
void NXOpen::PDM::PersistentSettings::SetGroup ( const char *  group)

Sets the Teamcenter group in which the user acts by default.

Should be one of those given by PDM::PersistentSettings::GetGroups


Created in NX4.0.0.

License requirements : None

Parameters
groupgroup
void NXOpen::PDM::PersistentSettings::SetVolume ( const NXString volume)

Sets the Teamcenter volume to which the user used by default.

Should be one of those given by PDM::PersistentSettings::GetVolumes
Created in NX4.0.0.

License requirements : None

Parameters
volumevolume
void NXOpen::PDM::PersistentSettings::SetVolume ( const char *  volume)

Sets the Teamcenter volume to which the user used by default.

Should be one of those given by PDM::PersistentSettings::GetVolumes
Created in NX4.0.0.

License requirements : None

Parameters
volumevolume
NXString NXOpen::PDM::PersistentSettings::Volume ( )

Returns the Teamcenter volume to which the user used by default.

Should be one of those given by PDM::PersistentSettings::GetVolumes
Created in NX4.0.0.

License requirements : None


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