bstr_object_get_status(3) — Subroutines

Name

bstr_object_get_status − Returns the status of a Data_Point (VODB only).

Syntax

bstr_t_status   bstr_object_get_status (
                                  bstr_t_reference       ∗object,
                                  bstr_t_rcb             ∗control,
                                  bstr_t_object_status   ∗status);

Description

The bstr_object_get_status procedure returns in status the current status of the Data_Point referred to by object.

Arguments

object
access: read
The reference to the Data_Point whose status is to be read.

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

status
access: write
The address of a bstr_t_object_status structure which returns status information. In order to test the information returned in the status field, the following bit masks are provided:

Constant	Description
BSTR_C_INITIALIZED	Indicates that the Data_Point has been initialized. A Data_Point is initialized when its current_value is set to a specific default value, or when a put_value service request is performed on it at least once.
BSTR_C_EXPIRED	Indicates that the lifetime has expired. BASEstar Open sets this flag to FALSE each time a put_value operation is performed on the Data_Point.
BSTR_C_LINK_DOWN	Indicates that the link toward the device variable is down (only significant for Device_Data_Points).
BSTR_C_MODIFIED	Indicates that the value of the Data_Point has been modified at least once.
BSTR_C_EXTERNAL_ERROR	Indicates that BASEstar Open has encountered an error while performing an operation on the external resource associated with an External_Data_Point.

Return Values