Skip to content

libcURL.CookieEngine.Lookup

Andrew Lambert edited this page Jan 8, 2023 · 17 revisions

Method Signature

 Function Lookup(CookieName As String, CookieDomain As String, StartWith As Integer = 0, Strict As Boolean = True) As Integer

Parameters

Name Type Comment
CookieName String The name of the cookie to locate
CookieDomain String The domain name of the cookie to locate
StartWith Integer Optional. If specified, the index to begin searching at
Strict Boolean Optional. If False then less-strict matching will be applied.

Return value

The index of the first matching cookie, or -1 if no cookies match.

Remarks

Locates the index of the first/next cookie matching the CookieName and CookieDomain parameters. To continue searching from a previous index specify a StartWith index that is 1 greater than the previous index.

If CookieDomain is the empty string ("") then all domains match. If CookieName is the empty string then all cookies for CookieDomain match. If both are the empty string then all cookies match (i.e. StartWith is returned.)

If Strict is True, then a cookie will match if it exactly matches the CookieName and originates from CookieDomain or one of its subdomains (i.e. a same-origin match).

If Strict is False, then a cookie will match if the name and domain contain the CookieName and CookieDomain strings.

See also

Clone this wiki locally