LsaRetrievePrivateData function (ntsecapi.h)

Do not use the LSA private data functions for generic data encryption and decryption. Instead, use the CryptProtectData and CryptUnprotectData functions. Only use the LSA private data functions when it is necessary to manipulate LSA secrets as documented in Secret Object Data Model

Syntax

NTSTATUS LsaRetrievePrivateData(
  [in]  LSA_HANDLE          PolicyHandle,
  [in]  PLSA_UNICODE_STRING KeyName,
  [out] PLSA_UNICODE_STRING *PrivateData
);

Parameters

[in] PolicyHandle

A handle to a Policy object. The handle must have the POLICY_GET_PRIVATE_INFORMATION access right. For more information, see Opening a Policy Object Handle.

[in] KeyName

Pointer to an LSA_UNICODE_STRING structure that contains the name of the key under which the private data is stored.

To create a specialized object, add one of the following prefixes to the key name.

If you are not creating one of these specialized types, you do not need to specify a key name prefix. For more information, see Private Data Object.

[out] PrivateData

Pointer to a variable that receives a pointer to an LSA_UNICODE_STRING structure that contains the private data.

When you no longer need the information, pass the returned pointer to LsaFreeMemory.

Return value

If the function succeeds, the function returns STATUS_SUCCESS.

If the function fails, it returns an NTSTATUS value, which can be the following value or one of the LSA Policy Function Return Values.

You can use the LsaNtStatusToWinError function to convert the NTSTATUS value to a Windows error code.

Remarks

You must run this process "As Administrator" or the call fails with ERROR_ACCESS_DENIED.

Requirements

See also

LSA_UNICODE_STRING

LsaFreeMemory

LsaStorePrivateData