Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision | |||
|
en:bs2_getaccessgroupentrancelimit [2018/11/14 08:50] kkshin removed |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ~~NOTOC~~ | ||
| - | [[zone_control_api]] > [[BS2_GetAccessGroupEntranceLimit]] | ||
| - | |||
| - | ---- | ||
| - | |||
| - | ===== BS2_GetAccessGroupEntranceLimit===== | ||
| - | Retrieves selected access group entrance limit. | ||
| - | ==== Supported devices ==== | ||
| - | BioStation 2 (1.5.0 only) \\ | ||
| - | BioStatioin A2 (1.4.0 only) \\ | ||
| - | BioEntry P2 (1.0.0 only) \\ | ||
| - | ==== Declaration ==== | ||
| - | <code cpp> | ||
| - | #include "BS_API.h" | ||
| - | |||
| - | int BS2_GetAccessGroupEntranceLimit(void* context, BS2_DEVICE_ID deviceId, const BS2_ZONE_ID* Ids, uint32_t IdCount, BS2DeviceZoneAGEntranceLimit** agEntranceLimitObj, uint32_t* numAGEntranceLimit); | ||
| - | </code> | ||
| - | |||
| - | <callout type="info"> | ||
| - | [[zone control api#BS2DeviceZoneAGEntranceLimit|See BS2DeviceZoneAGEntranceLimit Structure]] | ||
| - | </callout> | ||
| - | ==== Parameter ==== | ||
| - | * [In] ''//context//'' : Context | ||
| - | * [In] ''//deviceId//'' : Device ID | ||
| - | * [In] ''//Ids//'' : Device zone access group entrance limit IDs list trying to get | ||
| - | * [In] ''//IdCount//'' : Size of device device zone access group entrance limit IDs list | ||
| - | * [Out] ''//agEntranceLimitObj//'' : Device zone access group entrance limit pointer | ||
| - | * [Out] ''//numAGEntranceLimit//'' : Number of device zone access group entrance limit list | ||
| - | <WRAP indent> | ||
| - | <WRAP info 70%> | ||
| - | **NOTE**\\ | ||
| - | The zoneObj variable needs to return the memory to the system by the [[BS2_ReleaseObject]] function after being used. | ||
| - | </WRAP> | ||
| - | </WRAP> | ||
| - | ==== Return Value ==== | ||
| - | If successfully done, ''BS_SDK_SUCCESS'' will be returned. \\ | ||
| - | If there is an error, the corresponding error code will be returned. | ||
| - | \\ | ||
| - | ==== See Also ==== | ||
| - | [[BS2_GetAllAccessGroupEntranceLimit]]\\ [[BS2_SetAccessGroupEntranceLimit]]\\ [[BS2_RemoveAccessGroupEntranceLimit]]\\ [[BS2_RemoveAllAccessGroupEntranceLimit]] | ||