NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | 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 NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe void Apply ()
 Applies any changes to the settings More...
 
unsafe string[] GetGroups ()
 Gets the names of the Teamcenter groups to which the user belongs. More...
 
unsafe string[] GetVolumes ()
 Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM.PersistentSettings.GetGroups . More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Free resources associated with the instance. More...
 

Properties

unsafe string Group [get, set]
 Returns or sets the Teamcenter group in which the user acts by default. More...
 
unsafe string Volume [get, set]
 Returns or sets the Teamcenter volume to which the user used by default. More...
 
- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. 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

Member Function Documentation

unsafe void NXOpen.PDM.PersistentSettings.Apply ( )
inline

Applies any changes to the settings

Created in NX4.0.0

License requirements: None.

override void NXOpen.PDM.PersistentSettings.FreeResource ( )
inlineprotectedvirtual

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.

Implements NXOpen.TransientObject.

unsafe string [] NXOpen.PDM.PersistentSettings.GetGroups ( )
inline

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

Created in NX4.0.0

License requirements: None.

Returns
the names of the groups
unsafe string [] NXOpen.PDM.PersistentSettings.GetVolumes ( )
inline

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

Created in NX4.0.0

License requirements: None.

Returns
the names of the volumes

Property Documentation

unsafe string NXOpen.PDM.PersistentSettings.Group
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PDM.PersistentSettings.Volume
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.


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