Login Method (IMMLoginObject)

This routine is used to login to the system database. Custom login objects can bring up a customized login dialog here, collect connection information, and perform other tasks. The vbInitialLogin parameter is True at the startup of ArcMap. It has a value of False when the login command is called from the ArcFM Solution toolbar. The login method itself should return a value indicating whether or not the user has logged into a different database.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Function Login( _
   ByVal vbInitialLogin As System.Boolean _
) As System.Boolean

'Usage
 
Dim instance As IMMLoginObject
Dim vbInitialLogin As System.Boolean
Dim value As System.Boolean
 
value = instance.Login(vbInitialLogin)

System.bool Login( 
   System.bool vbInitialLogin
)

function Login( 
    vbInitialLogin: System.Boolean
): System.Boolean;

function Login( 
   vbInitialLogin : System.boolean
) : System.boolean;

System.bool Login( 
   System.bool vbInitialLogin
)

System.bool Login( 
   System.bool vbInitialLogin
)

Parameters

vbInitialLogin: Returns a boolean value indicating whether the user has previously logged into the database. The parameter is True when ArcMap is initially opened. Once the user clicks the Login button on the ArcFM Solution toolbar, the parameter value changes to False. This indicates that the user has logged into another database.

Return Value

Returns a boolean value indicating whether or not the user has logged into a different database.

Remarks

The login method must provide a fairly comprehensive implementation. There are a number of things to consider:

You’ll have to use the SDEWorkspaceFactory class to open your login workspace. This class implements an interface called ISetDefaultConnectionInfo (see ArcObjects documentation), which contains a method named SetParameters. This method must be called and sent the appropriate parameters, depending on your login workspace.
Keep in mind that there are types of workspaces that will not accomodate an ArcFM system database. For example, ArcGIS coverage workspaces and shapefile workspaces will not support ArcFM system tables. Your custom login object will need to check for this.
Very importantly, a custom login object will need to test for the existence of the ArcFM system tables. Otherwise, your users stand the chance of logging into a database that isn’t really an ArcFM system database.

Example

The following code sample demonstrates how the IMMLoginObject::Login method may be implemented.

Visual Basic Copy Code

Private Function IMMLoginObject_Login(ByVal vbInitialLogin As Boolean) As Boolean

                                    

                                        Dim pArcFMDefaultLogin As IMMDefaultLoginObject

                                        Set pArcFMDefaultLogin = m_pDefaultLogin 'QI

                                    

                                        'You can use vbInitialLogin to check if this is

                                        'the first login

                                        If vbInitialLogin Then

                                            Dim sDBPath As String

                                            sDBPath = "D:\Databases\System.mdb"

                                    

                                            With m_pPropertySet

                                                .SetProperty "DATABASE", sDBPath

                                                .SetProperty "USERNAME", "testUser"

                                            End With

                                    

                                            'we do not want to see the default login dialog

                                            pArcFMDefaultLogin.ShowDialog = False

                                    

                                            'set the connection properties for the default login object

                                            pArcFMDefaultLogin.SetConnectionProperties m_pPropertySet

                                    

                                            'Call the login method on the default login object

                                        Else

                                            'User has clicked the login button from the ArcFM Toolbar

                                            pArcFMDefaultLogin.ShowDialog = True

                                        End If

                                            m_pDefaultLogin.Login vbInitialLogin

                                    End Function

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IMMLoginObject Interface
IMMLoginObject Members