CCookie::getDiscard

The CCookie::getDiscard function retrieves the Discard attribute of the cookie.

bool getDiscard();


Return Type

bool
A boolean value which contains the Discard attribute of the cookie is returned.


Parameters

None.


Remarks

This function retrieves the Discard attribute of the cookie. The Discard attribute instructs the user agent to discard the cookie unconditionally when the user agent terminates.

The CCookie::setDiscard function can be used to set the Discard attribute of the cookie.


See Also

CCookie, CCookie::setDiscard, CResponse::addCookie, CRequest::getCookies, CRequest::getCookie

Example