dbCreateMarker
dbCreateMarker(
d_cellviewId
t_msg
t_tool
l_points
[ ld_objects ]
[ g_isVisible ]
[ g_isClosed ]
[ t_severity ]
[ t_shortMsg ]
[ t_deleteWhen ]
)
=> d_markerId / nil
Description
Creates a marker object in the specified cellview.
Arguments
|
d_cellviewId
|
The database ID of the cellview.
|
|
t_msg
|
Message associated with the marker.
|
|
t_tool
|
Name value of the application associated with this marker.
|
|
l_points
|
Specifies the list of points for the marker.
|
|
ld_objects
|
Optional argument that specifies the list of database ID’s of the objects associated with the marker.
Default Value:
nil
|
|
g_isVisible
|
Optional boolean argument that indicates if the marker is visible
Valid values:
t, nil
Default Value:
t
|
|
g_isClosed
|
Optional argument that specifies if the pointArray of the marker is closed.
Valid values:
t, nil
Default Value:
t
|
|
t_severity
|
Optional argument that specifies the severity of the violation shown by the marker.
Valid values:
annotation, info, acknowledgedWarning, warning, signedOffError, error, signedOffCriticalError, criticalError, fatalError, unsupported.
Default Value:
annotation
|
|
t_shortMsg
|
Optional argument that specifies the shortMsg associated with the marker.
Default Value:
""
|
|
t_deleteWhen
|
Optional argument that specifies when markers are automatically deleted.
Valid values:
deleteNever, deleteFirst, deleteLast, deleteModify.
Default Value:
"deleteNever"
|
Value Returned
|
d_markerId
|
The database ID of the marker if the creation is successful.
|
|
nil
|
nil is returned if the cellview ID is invalid.
|
Related Topics
Database Access Function Argument Types
Marker Attributes
Marker Functions
Return to top
