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

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. This class is deprecated.

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

Public Function LoginUser (
	szRetURL As String,
	iTimeWindow As Integer,
	fForceLogin As Integer,
	szCOBrandArgs As String,
	iLangID As Integer,
	strNameSpace As String,
	iKPP As Integer,
	iUseSecureAuth As Integer,
	oExtraParams As Object
) As Integer

Parameters

szRetURL
Type: System.String

The URL to which the Login server should redirect users after sign in is complete. Pass null to indicate that Passport should use the default value.

iTimeWindow
Type: System.Int32

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

fForceLogin
Type: System.Int32

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
Type: System.String

A string specifying variables to be appended as query string variables to the URL of the participant's Cobranding Template script page. Pass null to indicate that Passport should use the default value.

iLangID
Type: System.Int32

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
Type: System.String

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 null to indicate that Passport should use the default value.

iKPP
Type: System.Int32

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
Type: System.Int32

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
Type: System.Object

Name-value pairs to be inserted directly into the challenge authentication header, specifically for Passport-aware authentication interaction. Pass null to indicate that Passport should use the default value.

Return Value

Type: System.Int32

An integer result code.

This class has been deprecated and is no longer supported. Microsoft Passport Network has been replaced by Windows Live ID. For more information about how to use Windows Live ID to authenticate users in a Web application, see Windows Live ID SDK.

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft