InternetGetCookie Function

Retrieves the cookie for the specified URL.

Syntax

BOOL InternetGetCookie%(
    IN  LPCTSTR% lpszUrlName,
    IN  LPCTSTR% lpszCookieName,
    OUT LPTSTR% lpszCookieData,
    IN OUT LPDWORD  lpdwSize
);

The actual syntax of this function varies between its ANSI and Unicode implementations. See the Win32 Internet Functions Syntax document for details.

Parameters

lpszUrlName

Address of a string that contains the URL to get cookies for.

lpszCookieName

Address of a string that contains the name of the cookie to get for the specified URL. This has not been implemented in this release.

lpszCookieData

Address of the buffer that receives the cookie data. This value can be NULL.

lpdwSize

Address of an unsigned long integer variable that specifies the size of the lpszCookieData buffer. If the function succeeds, the buffer receives the amount of data copied to the lpszCookieData buffer. If lpszCookieData is NULL, this parameter receives a value that specifies the size of the buffer necessary to copy all the cookie data.

Return Value

Returns TRUE if successful, or FALSE otherwise. To get a specific error value, call GetLastError. The following error values apply to InternetGetCookie:

ERROR_NO_MORE_ITEMS	There is no cookie for the specified URL and all its parents.
ERROR_INSUFFICIENT_BUFFER	The value passed in lpdwSize is insufficient to copy all the cookie data. The value returned in lpdwSize is the size of the buffer necessary to get all the data.

Remarks

InternetGetCookie does not require a call to InternetOpen. InternetGetCookie checks in the windows\cookies directory for persistent cookies that have an expiration date set sometime in the future. InternetGetCookie also searches memory for any session cookies (cookies that do not have an expiration date) that were created in the same process by InternetSetCookie, since these cookies are not written to any files. Rules for creating cookie files are internal to Win32® Internet functions and might change in the future.

Function Information

Windows NT	Use version 4.0 and later. Implemented as ANSI and Unicode functions.
Windows	Use Windows 95 and later. Implemented as ANSI and Unicode functions.
Header	Wininet.h
Import library	Wininet.lib
Minimum availability	Internet Explorer 3.0 (ANSI only), 5 (ANSI and Unicode)

See Also

Microsoft Win32 Internet Functions Overview, Managing Cookies, Microsoft Win32 Internet Functions Reference, Cookie Functions

Does this content meet your programming needs? Write us!

Back to top