PortalLogin Method (String, String, String, String, String, Int16, Boolean, Boolean) |
This method creates and validates the connection to SQL Server. It also
verifies the existence and checks the state of the TaxEngine tables.
If the
tables do not exist and the user has create rights, this method will
create the missing tables.
Namespace: KampData.TaxEngine.APIAssembly: KDTaxEngine (in KDTaxEngine.dll) Version: 3.0.5512.25362
Syntax public string Login(
string server,
string userId,
string password,
string systemDatabase,
string companyDatabase,
short timeOutSeconds,
bool displayProgressBar,
bool useSqlPassword
)
Public Function Login (
server As String,
userId As String,
password As String,
systemDatabase As String,
companyDatabase As String,
timeOutSeconds As Short,
displayProgressBar As Boolean,
useSqlPassword As Boolean
) As String
public:
String^ Login(
String^ server,
String^ userId,
String^ password,
String^ systemDatabase,
String^ companyDatabase,
short timeOutSeconds,
bool displayProgressBar,
bool useSqlPassword
)
member Login :
server : string *
userId : string *
password : string *
systemDatabase : string *
companyDatabase : string *
timeOutSeconds : int16 *
displayProgressBar : bool *
useSqlPassword : bool -> string
Parameters
- server
- Type: SystemString
SQL Server name as used in the connection string. - userId
- Type: SystemString
Microsoft Dynamics GP Login Name - password
- Type: SystemString
Microsoft Dynamics GP Password - systemDatabase
- Type: SystemString
This is typically DYNAMICS - companyDatabase
- Type: SystemString
SQL Server company database name - timeOutSeconds
- Type: SystemInt16
Seconds elapsed before login times out. This
setting will be set to the default if it is less than 2 seconds. The default
is 15 seconds. - displayProgressBar
- Type: SystemBoolean
Display a progress bar to show time remaining
before timeout. - useSqlPassword
- Type: SystemBoolean
Use the password assigned on SQL server to
authenticate the user. This is
designed for use on a server other than
one running Dynamics GP as Dynamics encrypts non-sa passwords.
Return Value
Type:
StringAn empty string if login is successful. An error message
if not.
Exceptions Exception | Condition |
---|
SqlLoginException |
Thrown if the user has insufficient rights to the required SQL tables or
if another login error is encountered.
|
See Also