Función InternetGetCookieExA (wininet.h)

Artículo
08/27/2023

La función InternetGetCookieEx recupera los datos almacenados en cookies asociadas a una dirección URL especificada. A diferencia de InternetGetCookie, InternetGetCookieEx se puede usar para restringir los datos recuperados a un único nombre de cookie o, por directiva, asociados a sitios que no son de confianza o cookies de terceros.

Sintaxis

BOOL InternetGetCookieExA(
  [in]                LPCSTR  lpszUrl,
  [in]                LPCSTR  lpszCookieName,
  [in, out, optional] LPSTR   lpszCookieData,
  [in, out]           LPDWORD lpdwSize,
  [in]                DWORD   dwFlags,
  [in]                LPVOID  lpReserved
);

Parámetros

[in] lpszUrl

Puntero a una cadena terminada en null que contiene la dirección URL con la que está asociada la cookie que se va a recuperar. Este parámetro no puede ser NULL o InternetGetCookieEx produce un error y devuelve un error de ERROR_INVALID_PARAMETER .

[in] lpszCookieName

Puntero a una cadena terminada en null que contiene el nombre de la cookie que se va a recuperar. Este nombre distingue mayúsculas de minúsculas.

[in, out, optional] lpszCookieData

Puntero a un búfer para recibir los datos de cookies.

[in, out] lpdwSize

Puntero a una variable DWORD.

En la entrada, la variable debe contener el tamaño, en TCHAR, del búfer al que apunta el parámetro pchCookieData .

Al salir, si la función se ejecuta correctamente, esta variable contiene el número de TCHAR de datos de cookies copiados en el búfer. Si se pasó NULL como parámetro lpszCookieData , o si se produce un error en la función con un error de ERROR_INSUFFICIENT_BUFFER, la variable contiene el tamaño, en BYTEs, del búfer necesario para recibir los datos de la cookie.

Este parámetro no puede ser NULL o InternetGetCookieEx produce un error y devuelve un error de ERROR_INVALID_PARAMETER .

[in] dwFlags

Marca que controla cómo la función recupera los datos de cookies. Este parámetro puede ser uno de los valores siguientes.

Valor	Significado
INTERNET_COOKIE_HTTPONLY	Habilita la recuperación de cookies marcadas como "HTTPOnly". No use esta marca si expone una interfaz scriptable, ya que esto tiene implicaciones de seguridad. Es imperativo que use esta marca solo si puede garantizar que nunca expondrá la cookie al código de terceros mediante un mecanismo de extensibilidad que proporcione. Versión: Requiere Internet Explorer 8.0 o posterior.
INTERNET_COOKIE_THIRD_PARTY	Recupera solo cookies de terceros si la directiva permite explícitamente que se recuperen todas las cookies de la dirección URL especificada.
INTERNET_FLAG_RESTRICTED_ZONE	Recupera solo las cookies que se permitirían si la dirección URL especificada no fuera de confianza; es decir, si pertenece a la zona URLZONE_UNTRUSTED.

Valor

Significado

INTERNET_COOKIE_HTTPONLY

Habilita la recuperación de cookies marcadas como "HTTPOnly".

No use esta marca si expone una interfaz scriptable, ya que esto tiene implicaciones de seguridad. Es imperativo que use esta marca solo si puede garantizar que nunca expondrá la cookie al código de terceros mediante un mecanismo de extensibilidad que proporcione.

Versión: Requiere Internet Explorer 8.0 o posterior.

INTERNET_COOKIE_THIRD_PARTY

Recupera solo cookies de terceros si la directiva permite explícitamente que se recuperen todas las cookies de la dirección URL especificada.

INTERNET_FLAG_RESTRICTED_ZONE

Recupera solo las cookies que se permitirían si la dirección URL especificada no fuera de confianza; es decir, si pertenece a la zona URLZONE_UNTRUSTED.

[in] lpReserved

Reservado para uso futuro. Se establece en NULL.

Valor devuelto

Si la función se ejecuta correctamente, la función devuelve TRUE.

Si se produce un error en la función, devuelve FALSE. Para obtener un valor de error específico, llame a GetLastError.

Si null se pasa a lpszCookieData, la llamada se realizará correctamente y la función no establecerá ERROR_INSUFFICIENT_BUFFER.

Esta función puede establecer los siguientes códigos de error.

Código devuelto	Descripción
ERROR_INSUFFICIENT_BUFFER	Se devuelve si los datos de cookies recuperados son mayores que el tamaño del búfer al que apunta el parámetro pcchCookieData o si ese parámetro es NULL.
ERROR_INVALID_PARAMETER	Se devuelve si el parámetro pchURL o pcchCookieData es NULL.
ERROR_NO_MORE_ITEMS	Se devuelve si no se pueden recuperar datos cookied según se especifique.

Comentarios

Nota WinINet no admite implementaciones de servidor. Además, no se debe usar desde un servicio. En el caso de las implementaciones de servidor o los servicios, use los servicios HTTP de Microsoft Windows (WinHTTP).

Nota

El encabezado wininet.h define InternetGetCookieEx como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	wininet.h
Library	Wininet.lib
Archivo DLL	Wininet.dll