LsaQueryForestTrustInformation function (ntsecapi.h)

Article
2024-02-22

The LsaQueryForestTrustInformation function retrieves forest trust information for the specified Local Security Authority TrustedDomain object.

Syntax

NTSTATUS LsaQueryForestTrustInformation(
  [in]  LSA_HANDLE                    PolicyHandle,
  [in]  PLSA_UNICODE_STRING           TrustedDomainName,
  [out] PLSA_FOREST_TRUST_INFORMATION *ForestTrustInfo
);

Parameters

[in] PolicyHandle

A handle to the Policy object for the system.

[in] TrustedDomainName

Pointer to an LSA_UNICODE_STRING structure that contains the name of the TrustedDomain object for which to retrieve forest trust information.

[out] ForestTrustInfo

Pointer to an LSA_FOREST_TRUST_INFORMATION structure that returns the forest trust information for the TrustedDomain object specified by the TrustedDomainName parameter.

Return value

If the function succeeds, the return value is STATUS_SUCCESS.

If the function fails, the return value is an NTSTATUS code, which can be one of the following values or one of the LSA Policy Function Return Values.

Return code/value	Description
STATUS_INVALID_DOMAIN_ROLE	The operation is legal only on the primary domain controller.
STATUS_INVALID_DOMAIN_STATE	The operation is legal only on domain controllers in the root domain.
STATUS_NO_SUCH_DOMAIN	The specified TrustedDomain object does not exist.
STATUS_NOT_FOUND	The specified TrustedDomain object does not contain forest trust information.

Remarks

Access to this function is protected by a securable object.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ntsecapi.h
Library	Advapi32.lib
DLL	Advapi32.dll

Share via