PassportIdentity.LoginUser Method

Definition

Namespace:

System.Web.Security

Assembly:

System.Web.dll

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

Overloads

LoginUser()	Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange. This class is deprecated.
LoginUser(String)	Logs the user on, either by generating a 302 redirect URL or initiating a Passport-aware client authentication exchange. This class is deprecated.
LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)	Logs the user on, either by generating a 302 redirect URL or by initiating a Passport-aware client authentication exchange. This class is deprecated.
LoginUser(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.

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

LoginUser()

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

public:
 int LoginUser();

public int LoginUser();

member this.LoginUser : unit -> int

Public Function LoginUser () As Integer

Returns

Int32

An integer result code.

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

LoginUser(String)

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

public:
 int LoginUser(System::String ^ strReturnUrl);

public int LoginUser(string strReturnUrl);

member this.LoginUser : string -> int

Public Function LoginUser (strReturnUrl As String) As Integer

Parameters

strReturnUrl

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.

Returns

Int32

An integer result code.

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

LoginUser(String, Int32, Boolean, String, Int32, String, Int32, Boolean, Object)

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

public:
 int LoginUser(System::String ^ szRetURL, int iTimeWindow, bool fForceLogin, System::String ^ szCOBrandArgs, int iLangID, System::String ^ strNameSpace, int iKPP, bool fUseSecureAuth, System::Object ^ oExtraParams);

public int LoginUser(string szRetURL, int iTimeWindow, bool fForceLogin, string szCOBrandArgs, int iLangID, string strNameSpace, int iKPP, bool fUseSecureAuth, object oExtraParams);

member this.LoginUser : string * int * bool * string * int * string * int * bool * obj -> int

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

Parameters

szRetURL

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

Int32

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

fForceLogin

Boolean

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

szCOBrandArgs

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

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

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

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.

fUseSecureAuth

Boolean

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

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.

Returns

Int32

An integer result code.

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.

LoginUser(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.

public:
 int LoginUser(System::String ^ szRetURL, int iTimeWindow, int fForceLogin, System::String ^ szCOBrandArgs, int iLangID, System::String ^ strNameSpace, int iKPP, int iUseSecureAuth, System::Object ^ oExtraParams);

public int LoginUser(string szRetURL, int iTimeWindow, int fForceLogin, string szCOBrandArgs, int iLangID, string strNameSpace, int iKPP, int iUseSecureAuth, object oExtraParams);

member this.LoginUser : string * int * int * string * int * string * int * int * obj -> int

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

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

Int32

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

fForceLogin

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

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

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

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

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

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

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.

Returns

Int32

An integer result code.

Remarks

This class has been deprecated and is no longer supported. Microsoft Passport Network was replaced by Windows Live ID.