IClusCfgNetworkInfo::IsPrivate method

[This method is available for use only in Windows Server 2003.]

Determines whether the network has been configured to be a private network.

Syntax

HRESULT IsPrivate();

Parameters

This method has no parameters.

Return value

The IsPrivate method returns one of the following values. Any other HRESULT value indicates that the call failed.

  • S_OK.
    The network has been configured to be a private network.

  • S_FALSE
    The network has not been configured to be a private network.

Remarks

The IsPrivate and IClusCfgNetworkInfo::IsPublic methods allow you to determine the role of a network (see Role Property for Networks). Refer to the following table. Note that the values listed in the Network role column come from the CLUSTER_NETWORK_ROLE enumeration.

IsPublic IsPrivate Network role

S_OK

S_OK

ClusterNetworkRoleInternalAndClient (0x00000003)

S_OK

S_FALSE

ClusterNetworkRoleClientAccess (0x00000002)

S_FALSE

S_OK

ClusterNetworkRoleInternal (0x00000001)

S_FALSE

S_FALSE

ClusterNetworkRoleNone (0)

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2003

End of server support

Windows Server 2003

IDL

ClusCfgServer.idl

DLL

ClCfgSrv.dll

IID

IID_IClusCfgNetworkInfo is defined as 19FC7580-950A-44A6-966E-74B14B20918F

See also

IClusCfgNetworkInfo

IClusCfgNetworkInfo::IsPublic

CLUSTER_NETWORK_ROLE