All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATSchPlatformInterfaces Interface CATISchArrowDisplay
System.IUnknown
|
+---CATISchArrowDisplay
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISchArrowDisplay
Interface to manage arrow display attributes on routes.
Role: To add/remove arrow display attributes on routes.
Method Index
- o
IsArrowShown(CATBoolean*)
- Query whether flow arrows are shown (arrow attributes exist).
- o
SetArrow(CATISchGRRRoute*,int)
- Add arrow display attributes on the route.
- o
UnsetArrow(CATISchGRRRoute*,int)
- Remove arrow display attributes on the route.
Methods
o IsArrowShown
-
Query whether flow arrows are shown (arrow attributes exist).
- Parameters:
-
- oBYes
- If TRUE, then Flow arrows are shown (arrow attributes exist).
If FALSE, then Flow arrows are not shown (arrow attributes do not exist).
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o SetArrow
-
Add arrow display attributes on the route.
- Parameters:
-
- iGRR
- iGRR means apply only to segments of iGRR.
(if iGRR = NULL, apply to segments of all GRR's of the route,
and ignore iSegNum)
- iSegNum
- iSegNum = 0 means apply to all segments of iGRR.
iSegnum > 0 means apply to only to segment number iSegNum iGRR.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
o UnsetArrow
-
Remove arrow display attributes on the route.
- Parameters:
-
- iGRR
- iGRR means apply only to segments of iGRR.
(if iGRR = NULL, apply to segments of all GRR's of the route,
and ignore iSegNum)
- iSegNum
- iSegNum = 0 means apply to all segments of iGRR.
iSegnum > 0 means apply to only to segment number iSegNum iGRR.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- operation is successful
- E_FAIL
- operation failed
This object is included in the file: CATISchArrowDisplay.h