Edit

Share via

TcGetFlowNameA function (traffic.h)

  • Article

The TcGetFlowName function provides the name of a flow that has been created by the calling client. Flow properties and other characteristics of flows are provided based on the name of a flow. Flow names can also be retrieved by a call to the TcEnumerateFlows function.

Syntax

ULONG TcGetFlowNameA(
  [in]  HANDLE FlowHandle,
  [in]  ULONG  StrSize,
  [out] LPSTR  pFlowName
);

Parameters

[in] FlowHandle

Handle for the flow.

[in] StrSize

Size of the string buffer provided in pFlowName.

[out] pFlowName

Pointer to the output buffer holding the flow name.

Return value

Return code Description
NO_ERROR
 The function executed without errors.
ERROR_INVALID_HANDLE
 The flow handle is invalid.
ERROR_INVALID_PARAMETER
 One of the parameters is invalid.
ERROR_INSUFFICIENT_BUFFER
 The buffer is too small to contain the results.

Remarks

Use of the TcGetFlowName function requires administrative privilege.

Note

The traffic.h header defines TcGetFlowName as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header traffic.h
DLL Traffic.dll

See also

TcEnumerateFlows