nsIAuthModule

IID:991eff7c-a8ba-441a-b71b-753bd8e6d6be
Inherits From:nsISupports
Added:New since Mozilla 1.4

Methods

void getNextToken ( voidPtr* inToken , PRUint32 inTokenLength , out voidPtr* outToken , out PRUint32 outTokenLength ) void init ( PRUnichar* domain , PRUnichar* username , PRUnichar* password )

void getNextToken ( voidPtr* inToken , PRUint32 inTokenLength , out voidPtr* outToken , out PRUint32 outTokenLength )

Called to get the next token in a sequence of authentication steps.

Arguments:
inToken: A buffer containing the input token (e.g., a challenge from a server). This may be null.
inTokenLength: The length of the input token.
outToken: If getNextToken succeeds, then outToken will point to a buffer to be sent in response to the server challenge. The length of this buffer is given by outTokenLength. The buffer at outToken must be recycled with a call to nsMemory::Free.
outTokenLength: If getNextToken succeeds, then outTokenLength contains the length of the buffer (number of bytes) pointed to by outToken.

void init ( PRUnichar* domain , PRUnichar* username , PRUnichar* password )

Called to initialize an auth module. The other methods cannot be called unless this method succeeds.

Arguments:
domain: the authentication domain, which may be null if not applicable.
username: the user's login name
password: the user's password

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com