int aw_query (int x_sector, int z_sector, int sequence[3][3]) |
|
aw_query queries for property in a three by three sector area. Callback AW_CALLBACK_QUERY Notes
For a complete description of how to use aw_query, see Property. sequence is a 3x3 array of sector sequence numbers. These sequence numbers come from previous calls to aw_query and indicate the last time your application queried property in this zone. A zero sequence number indicates that you have no previous property for that sector. To get a complete property update for the entire zone, set all nine sequence numbers to zero. A single call to aw_query may not be sufficient to update the entire area. After the call completes (or within the context of the AW_CALLBACK_QUERY callback) the value of the boolean attribute AW_QUERY_COMPLETE indicates whether aw_query should be called again to get more property. It may be necessary to call aw_query many times in order to get the contents of the entire three by three sector area. Once AW_QUERY_COMPLETE is TRUE, live update mode is enabled. This means your application may start receiving AW_EVENT_OBJECT_ADD and AW_EVENT_OBJECT_DELETE events if the surrounding property is being modified by other users. Applications using version 3.2 or later of the SDK and wishing to query larger areas of property at once should consider using the method aw_query_5x5. Example int sequence[3][3]; memset (sequence, 0, sizeof (sequence)); aw_query (0, 0, sequence); See Also aw_cell_next |