Platform SDK: Quality of Service

TcQueryFlow

The TcQueryFlow function queries traffic control for the value of a specific flow parameter based on the name of the flow. The name of a flow can be retrieved from the TcEnumerateFlows function or from the TcGetFlowName function.

DWORD TcQueryFlow (
  LPTSTR FlowName,
  PGUID pGuidParam,
  OUT PULONG pBufferSize,
  PVOID Buffer 
);

Parameters

FlowName
[in] Name of the flow being queried.
pGuidParam
[in] Pointer to the globally unique identifier (GUID) that corresponds to the flow parameter of interest. A list of traffic control's GUIDs can be found in GUID.
pBufferSize
[in] Pointer to the size of the client-provided buffer or the number of bytes used by traffic control. For input, points to the size of Buffer, in bytes. For output, points to the actual amount of buffer space written with returned flow–parameter data, in bytes.
Buffer
[out] Pointer to the client-provided buffer in which the returned flow parameter is written.

Return Values

Error codes Description
NO_ERROR The function executed without errors.
ERROR_INVALID_PARAMETER A parameter is invalid.
ERROR_INSUFFICIENT_BUFFER The provided buffer is too small to hold the results.
ERROR_NOT_SUPPORTED The requested GUID is not supported.
ERROR_WMI_GUID_NOT_FOUND The device did not register for this GUID.
ERROR_WMI_INSTANCE_NOT_FOUND The instance name was not found, likely because the flow or the interface is in the process of being closed.

Note  Use of the TcQueryFlow function requires administrative privilege.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Traffic.h.
  Library: Use Traffic.lib.

See Also

TcEnumerateFlows, TcGetFlowName, GUID