Skip to content

Latest commit

 

History

History
100 lines (80 loc) · 3.33 KB

nf-clusapi-getclusternetworkid.md

File metadata and controls

100 lines (80 loc) · 3.33 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:clusapi.GetClusterNetworkId
GetClusterNetworkId function (clusapi.h)
Returns the identifier of a network.
GetClusterNetworkId
GetClusterNetworkId function [Failover Cluster]
PCLUSAPI_GET_CLUSTER_NETWORK_ID
PCLUSAPI_GET_CLUSTER_NETWORK_ID function [Failover Cluster]
_wolf_getclusternetworkid
clusapi/GetClusterNetworkId
clusapi/PCLUSAPI_GET_CLUSTER_NETWORK_ID
mscs.getclusternetworkid
mscs\getclusternetworkid.htm
MsCS
25091883-12fa-41b6-9ac0-70bc22db3f05
12/05/2018
GetClusterNetworkId, GetClusterNetworkId function [Failover Cluster], PCLUSAPI_GET_CLUSTER_NETWORK_ID, PCLUSAPI_GET_CLUSTER_NETWORK_ID function [Failover Cluster], _wolf_getclusternetworkid, clusapi/GetClusterNetworkId, clusapi/PCLUSAPI_GET_CLUSTER_NETWORK_ID, mscs.getclusternetworkid
clusapi.h
Windows
None supported
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
ClusAPI.lib
ClusAPI.dll
Windows
19H1
GetClusterNetworkId
clusapi/GetClusterNetworkId
c++
APIRef
kbSyntax
DllExport
ClusAPI.dll
GetClusterNetworkId

GetClusterNetworkId function

-description

Returns the identifier of a network. The PCLUSAPI_GET_CLUSTER_NETWORK_ID type defines a pointer to this function.

-parameters

-param hNetwork [in]

Handle to a network.

-param lpszNetworkId [out]

Pointer to the identifier of the network associated with hNetwork, including the null-terminating character.

-param lpcchName [in, out]

Pointer to the size of the lpszNetworkID buffer as a count of characters. On input, specify the maximum number of characters the buffer can hold, including the terminating NULL. On output, specifies the number of characters in the resulting name, excluding the terminating NULL.

-returns

If the operation succeeds, the function returns ERROR_SUCCESS.

If the operation fails, the function returns a system error code. The following is one of the possible values.

Return code Description
ERROR_MORE_DATA
The buffer pointed to by lpszNetworkID is not big enough to hold the result. The lpcchNetworkID parameter returns the number of characters in the result, excluding the terminating NULL.

-remarks

Note that lpcchNetworkID refers to a count of characters and not a count of bytes, and that the returned size does not include the terminating NULL in the count. For more information on sizing buffers, see Data Size Conventions.

-see-also

OpenClusterNetwork