Ets_Obj_Balloons_Get()
Note: Requires OPNET Development Kit
Abstract
Retrieves specified balloons.
Syntax
Ets_Obj_Balloons_Get (model_hndl, owner_hndl, related_hndl, source_tag)
| Argument | Type | Description |
|---|---|---|
model_hndl |
EtsT_Model_Handle |
model of interest |
owner_hndl |
EtsT_Obj_Handle |
owning object of interest |
related_hndl |
EtsT_Obj_Handle |
related object of interest |
source_tag |
const char * |
source tag identifier |
Return Type
PrgT_List *
Text string associated with element, or PRGC_NIL if element pointer is null.
Header
ets_api_balloon.h
Details
This function retrieves specified balloons, as follows:
- returns balloons for <
obj_hndl,related_hndl> withsource_tag - if
source_tag==NULL, return all balloons for <obj_hndl,related_hndl> - if
related_hndl==OBJ_INVALID_HANDLE, return all balloons owned byobj_hndl - if both
obj_hndlandrelated_hndl==OBJ_INVALID_HANDLE, return all balloons withsource_tag