Función CredReadW (wincred.h)

  • Artículo

La función CredRead lee una credencial del conjunto de credenciales del usuario. El conjunto de credenciales usado es el asociado a la sesión de inicio de sesión del token actual. El token no debe tener deshabilitado el SID del usuario.

Sintaxis

BOOL CredReadW(
  [in]  LPCWSTR      TargetName,
  [in]  DWORD        Type,
  [in]  DWORD        Flags,
  [out] PCREDENTIALW *Credential
);

Parámetros

[in] TargetName

Puntero a una cadena terminada en null que contiene el nombre de la credencial que se va a leer.

[in] Type

Tipo de la credencial que se va a leer. El tipo debe ser uno de los tipos definidos CRED_TYPE_*.

[in] Flags

Actualmente reservado y debe ser cero.

[out] Credential

Puntero a un único búfer de bloque asignado para devolver la credencial. Los punteros contenidos en el búfer son punteros a ubicaciones dentro de este único bloque asignado. El único búfer devuelto debe liberarse llamando a CredFree.

Valor devuelto

La función devuelve TRUE si se ejecuta correctamente y FALSE en caso de error. Se puede llamar a la función GetLastError para obtener un código de estado más específico. Se pueden devolver los siguientes códigos de estado:

  • ERROR_NOT_FOUND

    No existe ninguna credencial con el targetName especificado.

  • ERROR_NO_SUCH_LOGON_SESSION

    La sesión de inicio de sesión no existe o no hay ningún conjunto de credenciales asociado a esta sesión de inicio de sesión. Las sesiones de inicio de sesión de red no tienen un conjunto de credenciales asociado.

  • ERROR_INVALID_FLAGS

    Se especificó una marca que no es válida para el parámetro Flags .

Comentarios

Si el valor del miembro Type de la estructura CREDENTIAL especificada por el parámetro Credential es CRED_TYPE_DOMAIN_EXTENDED, se debe especificar un espacio de nombres en el nombre de destino. Esta función solo puede devolver una credencial del tipo especificado.

Nota

El encabezado wincred.h define CredRead 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o 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 wincred.h
Library Advapi32.lib
Archivo DLL Advapi32.dll