CredReadDomainCredentialsFn callback function (ntsecpkg.h)

Article
10/13/2021

Reads a domain credential from the Credential Manager.

Syntax

CredReadDomainCredentialsFn Credreaddomaincredentialsfn;

NTSTATUS Credreaddomaincredentialsfn(
  [in]  PLUID LogonId,
  [in]  ULONG CredFlags,
  [in]  PCREDENTIAL_TARGET_INFORMATIONW TargetInfo,
        ULONG Flags,
        PULONG Count,
  [out] PENCRYPTED_CREDENTIALW **Credential
)
{...}

Parameters

[in] LogonId

The logon ID for which to read credentials.

[in] CredFlags

Flags that determine the behavior of this function. The following flags are defined.

Value	Meaning
CREDP_FLAGS_IN_PROCESS 0x01	The caller is in-process.
CREDP_FLAGS_USE_MIDL_HEAP 0x02	The caller should use the midl_user_allocate function to allocate the Credential buffer.
CREDP_FLAGS_DONT_CACHE_TI 0x04	Do not cache target information.
CREDP_FLAGS_CLEAR_PASSWORD 0x08	The credential data is passed as clear text.
CREDP_FLAGS_USER_ENCRYPTED_PASSWORD 0x10	The credential data is encrypted by using the RtlEncryptMemory function.
CREDP_FLAGS_TRUSTED_CALLER 0x20	The caller is a trusted process.

[in] TargetInfo

A pointer to a CREDENTIAL_TARGET_INFORMATION structure that contains information about the target computer.

Flags

Reserved. This parameter must be set to zero.

Count

The number of elements in the Credential array.

[out] Credential

A pointer to a pointer to an array of ENCRYPTED_CREDENTIALW structures that receive the credentials that this function reads.

Return value

If the function succeeds, return STATUS_SUCCESS, or an informational status code.

If the function fails, return an NTSTATUS error code that indicates the reason it failed.

Remarks

A pointer to the CrediReadDomainCredentials function is available in the LSA_SECPKG_FUNCTION_TABLE structure received by the SpInitialize function.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ntsecpkg.h