websGetPassword GoAhead WebServer API GoAhead EMF

Synopsis

Return the currently configured password for the entire web site.

Prototype

 #include "webs.h"; 

 char_t *websGetPassword(); 

Parameters

None

Description

The websGetPassword procedure returns the decoded form of the current security password. The password is defined by calling websSetPassword. To use the password feature, the security handler must be installed by calling websUrlHandlerDefine for websSecurityHandler. This in done automatically in the GoAhead EMF. If you are using the GoAhead WebServer, this should be done in your main program. See main.c for examples.

Return Value

Returns a pointer to a statically allocated string containing the current security password.

Example

 
password = websGetPassword(); 

Stability Classification

Stable.

See Also

websSetPassword, websSecurityHandler