DS_SITE_COST_INFO structure (ntdsapi.h)

The DS_SITE_COST_INFO structure is used with the DsQuerySitesByCost function to contain communication cost data.

Syntax

typedef struct {
  DWORD errorCode;
  DWORD cost;
} DS_SITE_COST_INFO, *PDS_SITE_COST_INFO;

Members

errorCode

Contains a success or error code that indicates if the cost data for the site could be obtained. This member can contain one of the following values.

ERROR_SUCCESS

The communication cost of the site was obtained and is contained in the cost member of this structure.

ERROR_DS_OBJ_NOT_FOUND

The communication cost of the site cannot be obtained. The cost member of this structure should be ignored.

cost

If the errorCode member contains ERROR_SUCCESS, this member contains the communication cost value of the site. If the errorCode member contains ERROR_DS_OBJ_NOT_FOUND, this contents of this member is undefined.

Requirements

   
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Header ntdsapi.h

See also

DC and Replication Management Functions

DsQuerySitesByCost