bstr_object_delete(3) — Subroutines

Name

bstr_object_delete − Deletes an object or object definition belonging to the specified class.

Syntax

bstr_t_status bstr_object_delete (
bstr_t_reference ∗object;
bstr_t_rcb ∗control);

Description

The bstr_object_delete procedure deletes the object or object definition specified by the object. After deletion, the reference to the object is no longer valid.

The table below lists the conditions that must be satisfied in order to delete an object of each class.

Class Identifier	Deletion Conditions
DOMAIN	It must have no component objects or child Domains.
STRUCTURE_DATATYPE	It must not be referenced by objects of the following classes: Data_Point, Named_Variable, Unnamed_Variable, Structure_Datatype, and Array_Datatype. In addition, it must not be referenced in the filter_parameters or event_parameters of an existing Trigger, or in the input_parameter_types or output_parameter_types of an existing Packet.
ARRAY_DATATYPE	See STRUCTURE_DATATYPE.
TIMER	It must not be referenced in the timer attribute of a Trigger.
DATA_POINT	It must not be referenced by objects of the Trigger, Data_Point_Set or Mapped_Data_Point classes. It must not be referenced in the filter_parameters or event_parameters attributes of an existing Trigger, or be linked to another Data_Point.
DATA_POINT_SET	None
DEVICE_DATA_POINT	See DATA_POINT.
MAPPED_DATA_POINT	It must not be referenced by Trigger or Data_Point_Set objects, or in the filter_parameters or event_parameters of an existing Trigger.
FILTER	It must not be referenced by objects of the Trigger class.
TRIGGER	None
EVENT	It must not be referenced by objects of the Event_Set or Trigger classes, and must not have any current Event subscriptions.
EVENT_SET	It must not be associated with an Event subscription.
ENBOX	See EVENT_SET.
PACKET	None
PORT	None
ACTIVITY	None
ACTOR	It must not have Activity or Program components, or child Actors.
NODE	It must not be referenced by objects of the Activity class.
PROGRAM	It must not be referenced by objects of the Activity class.
NAMED_VARIABLE	It must not belong to a Polling_Set or be referenced by a Device_Data_Point.
UNNAMED_VARIABLE	It must not belong to a Polling_Set or be referenced by a Device_Data_Point.
PROTOCOL_PROFILE	It must not be referenced by a VMD.
VMD	It must not have the same scope as any existing Device Services objects.
VMD_EXTENSION_PARAMETER	It must not be referenced by a VMD.
MESSAGE	None
POLLING_SET	None

Arguments

object
access: read
The reference to the object to be deleted.

control
access: read
The address of an optional request control block.

Return Values

BSTR_S_ABORTED	Operation aborted
BSTR_S_BAD_PARAMETER	Bad parameter value
BSTR_S_BAD_REFERENCE	Bad reference
BSTR_S_COMMUNICATION_ERROR	Communication error
BSTR_S_COM_PC_SIZE_MISMATCH	Number of bytes requested does not match the number of bytes returned
BSTR_S_FINISH	Request aborted by bstr_finish
BSTR_S_INTERNAL_ERROR	Internal error
BSTR_S_INTR	Operation interrupted
BSTR_S_INVALID_OPERATION	Invalid operation
BSTR_S_INVALID_RCB	Invalid Request Control Block
BSTR_S_NORMAL	Normal successful completion
BSTR_S_NOT_IMPLEMENTED	Not yet implemented
BSTR_S_NOT_INITIALIZED	BASEstar Open not initialized
BSTR_S_NO_MEMORY	Insufficient virtual memory
BSTR_S_OBJECT_NOT_FOUND	Object not found
BSTR_S_TIMEOUT	Timeout expired
BSTR_S_TOO_MANY_REQUESTS	Too many pending requests