Documented the function pointer templates for object_functions, as used in device.c

This commit is contained in:
tbrennan3
2010-03-02 20:44:46 +00:00
parent d4b39c6b59
commit 6c799cb847
6 changed files with 60 additions and 2 deletions
+8
View File
@@ -50,6 +50,14 @@ typedef struct BACnet_Read_Property_Data {
BACNET_ERROR_CODE error_code;
} BACNET_READ_PROPERTY_DATA;
/** Reads one property for this object type of a given instance.
* A function template; @see device.c for assignment to object types.
*
* @param rp_data [in] Pointer to the BACnet_Read_Property_Data structure,
* which is packed with the information from the RP request.
* @return The length of the apdu encoded or -1 for error or
* -2 for abort message.
*/
typedef int (
*read_property_function) (
BACNET_READ_PROPERTY_DATA *rp_data);