Values for the settings that affect the current Teamcenter session. More...

Inheritance diagram for NXOpen.PDM.SessionSettings:

Public Member Functions
unsafe void	Apply ()
	Applies any changes to the settings More...

unsafe void	DumpValidationInfo (string logFileName)
	Dump the validation info . More...

unsafe string[]	GetGroups ()
	Gets the names of the Teamcenter groups to which the user belongs. More...

unsafe string[]	GetLocalVolumes ()
	Gets the names of the Teamcenter local volumes which the user may use, given the current group returned by PDM.SessionSettings.Group . More...

unsafe string[]	GetLocationCodes ()
	Gets the names of the Teamcenter location codes which the user may use, given the current group returned by PDM.SessionSettings.Group . More...

unsafe string[]	GetProjects ()
	Gets the names of the Teamcenter projects to which the user belongs also the first entry of the returned projects list is always empty. More...

unsafe string[]	GetRoles ()
	Gets the names of the Teamcenter roles in which the user may act, given the current group returned by PDM.SessionSettings.Group . More...

unsafe string[]	GetVolumes ()
	Gets the names of the Teamcenter volumes which the user may use, given the current group returned by PDM.SessionSettings.Group . 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 bool	AdministrationBypass `[get, set]`
	Returns or sets a flag controlling the Teamcenter administrator's bypass option. More...

unsafe bool	AdministrationLogging `[get, set]`
	Returns or sets a flag controlling Teamcenter administration logging. More...

unsafe bool	ApplicationLogging `[get, set]`
	Returns or sets a flag controlling Teamcenter application logging More...

unsafe string	Group `[get, set]`
	Returns or sets the Teamcenter group in which the user acts. More...

unsafe bool	IsAdministrator `[get]`
	Returns a flag indicating if the user has Teamcenter administator privileges. More...

unsafe bool	Journaling `[get, set]`
	Returns or sets a flag controlling Teamcenter journaling More...

unsafe string	LocalVolume `[get, set]`
	Returns or sets the Teamcenter local volume. More...

unsafe string	LocationCode `[get, set]`
	Returns or sets the Teamcenter location code. More...

unsafe string	Project `[get, set]`
	Returns or sets the Teamcenter project in which the user acts. More...

unsafe string	Role `[get, set]`
	Returns or sets the Teamcenter role in which the user acts. More...

unsafe bool	SecurityLogging `[get, set]`
	Returns or sets a flag controlling Teamcenter security logging. More...

unsafe string	Volume `[get, set]`
	Returns or sets the Teamcenter role in which the user acts. 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

Values for the settings that affect the current Teamcenter session.

Any changes will only take effect when PDM.SessionSettings.Apply is callsed.

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.PDM.SessionSettings.Apply ( )

inline

Applies any changes to the settings

Created in NX4.0.0

License requirements: None.

unsafe void NXOpen.PDM.SessionSettings.DumpValidationInfo ( string logFileName )

inline

Dump the validation info .

This API can be used to expose the current state from the UGMGR session, typically the information about the session,assembly,components,their states etc.

Created in NX6.0.0

License requirements: None.

Parameters

logFileName log file name

override void NXOpen.PDM.SessionSettings.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.SessionSettings.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.SessionSettings.GetLocalVolumes ( )

inline

Gets the names of the Teamcenter local volumes which the user may use, given the current group returned by PDM.SessionSettings.Group .

Created in NX12.0.0

License requirements: None.

Returns: the names of the local volumes

unsafe string [] NXOpen.PDM.SessionSettings.GetLocationCodes ( )

inline

Gets the names of the Teamcenter location codes which the user may use, given the current group returned by PDM.SessionSettings.Group .

Created in NX12.0.0

License requirements: None.

Returns: the names of the location codes

unsafe string [] NXOpen.PDM.SessionSettings.GetProjects ( )

inline

Gets the names of the Teamcenter projects to which the user belongs also the first entry of the returned projects list is always empty.

Created in NX8.5.0

License requirements: None.

Returns: the names of the projects

unsafe string [] NXOpen.PDM.SessionSettings.GetRoles ( )

inline

Gets the names of the Teamcenter roles in which the user may act, given the current group returned by PDM.SessionSettings.Group .

Created in NX4.0.0

License requirements: None.

Returns: the names of the roles

unsafe string [] NXOpen.PDM.SessionSettings.GetVolumes ( )

inline

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

Created in NX4.0.0

License requirements: None.

Returns: the names of the volumes

Property Documentation

unsafe bool NXOpen.PDM.SessionSettings.AdministrationBypass

getset

Returns or sets a flag controlling the Teamcenter administrator's bypass option.

Only available to administrators.

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PDM.SessionSettings.AdministrationLogging

getset

Returns or sets a flag controlling Teamcenter administration logging.

Only available to administrators.

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PDM.SessionSettings.ApplicationLogging

getset

Returns or sets a flag controlling Teamcenter application logging

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PDM.SessionSettings.Group

getset

Returns or sets the Teamcenter group in which the user acts.

Should be one of those given by PDM.SessionSettings.GetGroups

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PDM.SessionSettings.IsAdministrator

get

Returns a flag indicating if the user has Teamcenter administator privileges.

Some settings can are only available to administrators, and will raise errors if non-administrators try to access them.

Created in NX4.0.0

License requirements: None.

unsafe bool NXOpen.PDM.SessionSettings.Journaling

getset

Returns or sets a flag controlling Teamcenter journaling

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PDM.SessionSettings.LocalVolume

getset

Returns or sets the Teamcenter local volume.

Should be one of those given by PDM.SessionSettings.GetLocalVolumes

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PDM.SessionSettings.LocationCode

getset

Returns or sets the Teamcenter location code.

Should be one of those given by PDM.SessionSettings.GetLocationCodes

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PDM.SessionSettings.Project

getset

Returns or sets the Teamcenter project in which the user acts.

Should be one of those given by PDM.SessionSettings.GetProjects

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PDM.SessionSettings.Role

getset

Returns or sets the Teamcenter role in which the user acts.

Should be one of those given by PDM.SessionSettings.GetRoles

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.PDM.SessionSettings.SecurityLogging

getset

Returns or sets a flag controlling Teamcenter security logging.

Only available to administrators.

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.PDM.SessionSettings.Volume

getset

Returns or sets the Teamcenter role in which the user acts.

Should be one of those given by PDM.SessionSettings.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:

PDM_SessionSettings.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation