CONFIGMG_Query_Arbitrator_Free_Data

CONFIGRET CONFIGMG_Query_Arbitrator_Free_Data(PFARVOID pData, ULONG DataLen, DEVNODE dnDevNode, RESOURCEID ResourceID, ULONG ulFlags)
 

Returns arbitrator-specific free information.

• Returns CR_SUCCESS if the function is successful. Otherwise, the return value can be CR_BUFFER_SMALL, CR_FAILURE, CR_INVALID_DEVNODE, CR_INVALID_FLAG, CR_INVALID_POINTER, CR_INVALID_RESOURCEID or CR_NO_ARBITRATOR.

pData

Address of a buffer that receives the free information. This information is arbitrator specific.

DataLen

The size (in bytes) of the data buffer.

dnDevNode

Device node associated with the arbitrator. This is most meaningful for local arbitrators. (Although any device node can be used for global arbitrators, this parameter should specify the root or NULL in that case.)

ResourceID

One of the resource identifiers listed in the ResourceId parameter of the CONFIGMG_Add_Res_Des function. This function returns CR_INVALID_RESOURCEID if this value is ResType_All or ResType_None.

ulFlags

Must be zero.

This function succeeds even when it returns CR_BUFFER_SMALL. To avoid this error, call CONFIGMG_Query_Arbitrator_Free_Size before calling this function.

See Also

CONFIGMG_Add_Res_Des, CONFIGMG_Query_Arbitrator_Free_Size