Export (0) Print
Expand All

PassportIdentity.LoginUser Method (String, Int32, Int32, String, Int32, String, Int32, Int32, Object)

Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange.

Namespace: System.Web.Security
Assembly: System.Web (in system.web.dll)

public int LoginUser (
	string szRetURL,
	int iTimeWindow,
	int fForceLogin,
	string szCOBrandArgs,
	int iLangID,
	string strNameSpace,
	int iKPP,
	int iUseSecureAuth,
	Object oExtraParams
)
public int LoginUser (
	String szRetURL, 
	int iTimeWindow, 
	int fForceLogin, 
	String szCOBrandArgs, 
	int iLangID, 
	String strNameSpace, 
	int iKPP, 
	int iUseSecureAuth, 
	Object oExtraParams
)
public function LoginUser (
	szRetURL : String, 
	iTimeWindow : int, 
	fForceLogin : int, 
	szCOBrandArgs : String, 
	iLangID : int, 
	strNameSpace : String, 
	iKPP : int, 
	iUseSecureAuth : int, 
	oExtraParams : Object
) : int
Not applicable.

Parameters

szRetURL

The URL to which the Login server should redirect users after sign in is complete. Pass a null reference (Nothing in Visual Basic) to indicate that Passport should use the default value.

iTimeWindow

The time value, in seconds. Pass -1 to indicate that Passport should use the default value.

fForceLogin

Indicates whether the Login server should compare the iTimeWindow parameter against the time since the user last signed in or against the last time the Ticket was refreshed. Pass -1 to indicate that Passport should use the default value.

szCOBrandArgs

A string specifying variables to be appended as query string variables to the URL of the participant's Cobranding Template script page. Pass a null reference (Nothing in Visual Basic) to indicate that Passport should use the default value.

iLangID

A locale identifier (LCID) specifying the language in which the Login page should be displayed. Pass -1 to indicate that Passport should use the default value.

strNameSpace

A domain name space to which you want to direct users without Passports to register. The specified name space must appear as a "domain name" entry in the Partner.xml Component Configuration Document (CCD). The typical default name space is "passport.com". Pass a null reference (Nothing in Visual Basic) to indicate that Passport should use the default value.

iKPP

Pass -1 to indicate that Passport should use the default value. This parameter is only relevant when implementing Kids Passport service; however, Kids Passport service cannot currently support use of this method.

iUseSecureAuth

SSL sign-in is not available as an option in the current version Login servers. Passport Manager methods include SSL sign-in parameters and they may be required for syntax, but they are currently ignored at the server. Check the Passport Web site for updates on the status of SSL sign-in. Pass -1 to indicate that Passport should use the default value.

oExtraParams

Name-value pairs to be inserted directly into the challenge authentication header, specifically for Passport-aware authentication interaction. Pass a null reference (Nothing in Visual Basic) to indicate that Passport should use the default value.

Return Value

An integer result code.

The current primary purpose of the oExtraParams parameter is to pass in a value for the cbtxt variable. cbtxt is used to specify customizable text in the Credentials Manager dialog of Passport-aware applications, and is typically used to identify this authentication as being specifically a Passport authentication. The value following cbtxt= should be a quoted string, for instance cbtxt= "Logon to Passport".

For more information, see the Passport SDK documentation for IPassportManager2.LoginUser, available in the MSDN Library at http://msdn.microsoft.com/library.

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft