com.esri.arcgis.framework
Interface IGetUserAndPasswordDialog

All Superinterfaces:

Serializable

All Known Implementing Classes:

GetUserAndPasswordDialog, IGetUserAndPasswordDialogProxy

public interface IGetUserAndPasswordDialog
extends Serializable

Provides access to members that work with a dialog for getting user and password information.

Remarks

The get user and password dialog is a dialog used for getting username and password information.

To get access to the IGetUserAndPasswordDialog interface, create a new GetUserAndPasswordDialog object.

The following code shows a GetUserAndPassword dialog and validates the username and password that was entered in the dialog. You would get m_app from the hook in ICommand::OnCreate().

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	doModal(String dialogTitle, String stringLabel, int hWnd) Shows the dialog.
String	getPassword() The password entered in the dialog.
String	getUserName() The user name entered in the dialog.

Method Detail

getUserName

String getUserName()
                   throws IOException,
                          AutomationException

The user name entered in the dialog.

Remarks

The UserName property allows you to get the username that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The userName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPassword

String getPassword()
                   throws IOException,
                          AutomationException

The password entered in the dialog.

Remarks

The Password property allows you to get the password that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The password

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

boolean doModal(String dialogTitle,
                String stringLabel,
                int hWnd)
                throws IOException,
                       AutomationException

Shows the dialog.

Description

dialogTitle is a string that specifies the title of the dialog.

stringLabel specifies the label for the dialog.

hWnd specifies the window handle of the parent window. In most cases this will be the hWnd of the application.

Remarks

If the dialog was cancelled, the DoModal method returns False.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dialogTitle - The dialogTitle (in)

stringLabel - The stringLabel (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

The okPressed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.