IPassportManager::get_Error

Article
06/29/2006

IPassportManager::get_Error

A property that checks the Microsoft .NET Passport Ticket or query string for any errors that have been set by the .NET Passport domain authority upon direct user-network communication.

Syntax

HRESULT get_Error (
    long* pErrorVal
);

Parameters

pErrorVal
[out, retval] A pointer to a Long containing any error code sent by network servers through the Ticket cookie or on the query string.

Return values

Returns one of the following values:

S_OK Success.

E_INVALIDARG pErrorVal was a NULL pointer.

Remarks

A .NET Passport network error code is an integer value that is set by other servers in the .NET Passport network (for example, an Update or Login server) and can be used to identify errors or problem conditions after the user reaches a participating site. IPassportManager::get_Error returns any .NET Passport error code on the query string or in the .NET Passport Ticket cookie.

IPassportManager::get_Error returning zero to pErrorVal means that there are no error codes present.

Possible error codes and their meanings are listed in the following table:

Name VT_I4 value Description

BAD_REQUEST 1 The domain database received a partial request, the Site ID did not match, and so on.

OFFLINE 2 The domain database is offline and cannot handle requests.

TIMEOUT 3 The request to the domain database timed out.

LOCKED 4 The user's account is locked, the user is not signed in, or both.

NO_PROFILE 5 Not used.

DISASTER 6 The network server is not able to check the user database. If this error is received, your site should consider switching to stand-alone mode. The Login server has determined that some (although not all) of the network servers responsible for performing the steps of the authentication checks are currently down, and the Login server timed out trying to reach them. If F=6, the user will never be authenticated and no valid t and p will be on the query string.

INVALID_KEY 7 The Ticket or Profile cookie was encrypted using an invalid key and cannot be decrypted.

SVC_NOT_CONFIGURED 8 An error occurred during parsing or processing the participating site's XML site configuration data on the network side.

(no internal resource name) 9 Uncategorized or unhandled exception.

KPPNONKIDSITE 10 Site specified a value for KPP other than KPP=0 in a call to the Login server but was not configured to use Microsoft Kids Passport. Sites must contact their .NET Passport sales representative to make arrangements to use the Kids Passport service.

USER_CANCELLED 11 The presence of an f= parameter on the ru query string indicates an error that must be handled by the participating site. The general guidelines that apply are:

The ru must not redirect back to .NET Passport for another authentication. Redirecting back to the Login server will cause an infinite loop.

The ru may inspect the value of f= to identify which error occurred. If this value is known, the participating site may choose to display special messaging for the error. This messaging should be specific to the task the user was trying to accomplish.

If the participating site does not know the value of f, the site should display a generic error message indicating that an error occurred during .NET Passport sign-in.

This error must be caught on the participating sites ru. Failure to do so will put the user in an infinite loop.

NOT_OVER_SSL 12 When using SecLvl 10 or 100, the ru must point to a site using Secure Sockets Layer (SSL).

Share via

IPassportManager::get_Error

IPassportManager::get_Error

Additional resources

Name	VT_I4 value	Description
BAD_REQUEST	1	The domain database received a partial request, the Site ID did not match, and so on.
OFFLINE	2	The domain database is offline and cannot handle requests.
TIMEOUT	3	The request to the domain database timed out.
LOCKED	4	The user's account is locked, the user is not signed in, or both.
NO_PROFILE	5	Not used.
DISASTER	6	The network server is not able to check the user database. If this error is received, your site should consider switching to stand-alone mode. The Login server has determined that some (although not all) of the network servers responsible for performing the steps of the authentication checks are currently down, and the Login server timed out trying to reach them. If F=6, the user will never be authenticated and no valid t and p will be on the query string.
INVALID_KEY	7	The Ticket or Profile cookie was encrypted using an invalid key and cannot be decrypted.
SVC_NOT_CONFIGURED	8	An error occurred during parsing or processing the participating site's XML site configuration data on the network side.
(no internal resource name)	9	Uncategorized or unhandled exception.
KPPNONKIDSITE	10	Site specified a value for KPP other than KPP=0 in a call to the Login server but was not configured to use Microsoft Kids Passport. Sites must contact their .NET Passport sales representative to make arrangements to use the Kids Passport service.
USER_CANCELLED	11	The presence of an f= parameter on the ru query string indicates an error that must be handled by the participating site. The general guidelines that apply are: The ru must not redirect back to .NET Passport for another authentication. Redirecting back to the Login server will cause an infinite loop. The ru may inspect the value of f= to identify which error occurred. If this value is known, the participating site may choose to display special messaging for the error. This messaging should be specific to the task the user was trying to accomplish. If the participating site does not know the value of f, the site should display a generic error message indicating that an error occurred during .NET Passport sign-in. This error must be caught on the participating sites ru. Failure to do so will put the user in an infinite loop.
NOT_OVER_SSL	12	When using SecLvl 10 or 100, the ru must point to a site using Secure Sockets Layer (SSL).