Edit

Share via

IDiaSymbol11::get_tagRanges

  • Article

Retrieves the ranges of tags within a discriminated union symbol instance.

Syntax

HRESULT get_tagRanges(
  DWORD count,
  DWORD *pcRangeValues,
  DiaTagValue *rangeValues
);

Parameters

count

[in] Specifies the count of valid DiaTagValue elements pointed to by the rangeValues parameter.

pcRangeValues

[out] Returns the count of DiaTagValue elements needed if rangeValues is nullptr; otherwise returns the count of elements used.

rangeValues

[out] Returns an array of DiaTagValue. On input the count of valid elements is specified by the count parameter. Upon return *pcRangeValues is the count of valid elements that were filled in.

Return Value

If successful, returns S_OK; otherwise, returns an error code.

Note

A return value of S_FALSE means that the property is not available for the symbol.

Remarks

The first array element (rangeValues[0]) represents the lower bound of the range. The next array element represents the upper bound of the range. The array continues to alternate between lower and upper bounds of each subsequent range. Both upper and lower bounds are inclusive.

See also