INetwork2::IsDomainAuthenticatedBy method (netlistmgr.h)

Article
02/22/2024

Queries whether the specified domain authentication method succeeded for this network.

Syntax

HRESULT IsDomainAuthenticatedBy(
  NLM_DOMAIN_AUTHENTICATION_KIND domainAuthenticationKind,
  BOOL                           *pValue
);

Parameters

domainAuthenticationKind

Type: [in] NLM_DOMAIN_AUTHENTICATION_KIND

The specific domain authentication method to query about.

pValue

Type: [out, retval] BOOL*

The function dereferences pValue, and assigns TRUE if this network has the same domain authentication kind as that specified in the domainAuthenticationKind parameter; or FALSE if this network has a different domain authentication kind from that specified in domainAuthenticationKind.

Return value

Returns S_OK if successful.

Example

In this example, a hypothetical networking diagnostic tool seeks to ensure that connections to a corporate network have correct authentication properties.

void LogToConsole(std::wstring output, std::wstring networkName)
{
	// Implementation not shown for brevity.
}

void RunDiagnostics()
{
	winrt::com_ptr<::INetworkListManager> nlm;
	winrt::com_ptr<::IEnumNetworks> enumNetworks;
	winrt::com_ptr<::INetwork> network;
	ULONG numberOfNetworksEnumerated{ 0 };
	winrt::check_hresult(::CoCreateInstance(CLSID_NetworkListManager, nullptr, CLSCTX_ALL, IID_PPV_ARGS(&nlm)));
	winrt::check_hresult(nlm->GetNetworks(NLM_ENUM_NETWORK_ALL, enumNetworks.put()));

	while ((enumNetworks->Next(1, network.put(), &numberOfNetworksEnumerated) == S_OK))
	{
		try
		{
			if (numberOfNetworksEnumerated == 1)
			{
				winrt::com_ptr<::INetwork2> network2{ network.as<::INetwork2>() };
				BSTR networkName{};
				HRESULT hr{ network2->GetName(&networkName) };
				winrt::check_hresult(network2->GetName(&networkName));

				BOOL isLdapAuthenticated{ FALSE };
				BOOL isTlsAuthenticated{ FALSE };
				BOOL isNotDomainAuthenticated{ FALSE };
				winrt::check_hresult(network2->IsDomainAuthenticatedBy(NLM_DOMAIN_AUTHENTICATION_KIND_LDAP, &isLdapAuthenticated));
				winrt::check_hresult(network2->IsDomainAuthenticatedBy(NLM_DOMAIN_AUTHENTICATION_KIND_TLS, &isTlsAuthenticated));
				winrt::check_hresult(network2->IsDomainAuthenticatedBy(NLM_DOMAIN_AUTHENTICATION_KIND_NONE, &isNotDomainAuthenticated));

				if (!isNotDomainAuthenticated)
				{
					if (!!isLdapAuthenticated)
					{
						LogToConsole(L"Network is domain authenticated via LDAP", networkName);
					}

					if (!!isTlsAuthenticated)
					{
						LogToConsole(L"Network is domain authenticated via TLS", networkName);
					}

					if (!isLdapAuthenticated && !isTlsAuthenticated)
					{
						LogToConsole(L"Network was not expected to be domain authenticated for any other kinds", networkName);
					}
				}
				else
				{
					LogToConsole(L"Network is not domain authenticated", networkName);
				}
			}
		}
		catch (...)
		{
			// Handle exception.
		}
	}
}

Requirements

Requirement	Value
Minimum supported client	Windows 11 Build 22621
Target Platform	Windows
Header	netlistmgr.h

Share via