All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

People_and_Organisation Class CATVpmSCUsrLogin

CATVpmSCUsrLogin

public class CATVpmSCUsrLogin

Login management class.
Role: this class provides services to open a VPM login session, based on a user/password and a role, as in the standard VPM application. Use this API when you need to write you own applications that need access to the VPM database.

Method Index

o Login(char* const,char* const,char* const,char* const): Login.
o Logout(): Logout.

Methods

o Login

public static int Login(	const char* const	`iUserID`,
	const char* const	`iPassword`,
	const char* const	`iRoleName`,
	const char* const	`iRoleOrganizationID`)

Role: This method provides an all-in-one login service.

Parameters:

iUserID: VPM user ID.
iPassword: User password ; ignored in system authentication mode.
iRoleName: Role name to log on with.
iRoleOrganizationID: ID of the organization the role is attached to.

Returns:

0 when successful, error code otherwise.

See also:

CATVpmLoginError

o Logout

public static int Logout(

)

Logout.

Role: This method ends VPM login session.

Returns:: 0 when successful, error code otherwise.
See also:: CATVpmLoginError

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