All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

Product Class CATDMUsrEnvironment

CATDMUsrEnvironment

public class CATDMUsrEnvironment

BOM environment management class.
Role: this class provides services for getting and setting the current (in-work) VPM environment. In particular, it should be used accordingly with API CATDMUsrInstance, in order to set the environment before operating instances belonging to that environment. Precondition : the use of this class requires a valid connection to the database (@see CATVpmSCUsrLogin, CATDMUsrConnection).

Method Index

o Get(char[9]): Gets the current environment.
o Set(char[9]): Sets the environment.

Methods

o Get

public static Error Get( char[9] oEnvironment)

Gets the current environment.

Role: Use this method to retrieve the current working environment.

Parameters:

oEnvironment: Output environment.

Returns:

Error structure. The short and long messages are valuated, their de-allocation (using the delete[] operator) is the responsibility of the calling method.

See also:

CATDMUsrMethod

o Set

public static Error Set( const char[9] iEnvironment)

Sets the environment.

Role: Call this method before processing objects belonging to the environment. if it was previously unset or set to another value. Problems may occur accessing the profile if this method is not called accordingly.
Precondition: the implementation assumes a valid connection to the BOM database is already opened.

Parameters:

iEnvironment: Environment to connect to. If empty (not null), the environment will be set to the last known one, when possible.

Returns:

Error structure. The short and long messages are valuated, their de-allocation (using the delete[] operator) is the responsibility of the calling method.

This object is included in the file: CATDMUsrEnvironment.h
If needed, your Imakefile.mk should include the module: LV003DBA