~~NOTOC~~

[[access_control_api]] > [[BS2_GetAllHolidayGroup]]

----

===== BS2_GetAllHolidayGroup =====
Retrieves all holiday groups.
==== Declaration ====
<code cpp>
#include "BS_API.h"

int BS2_GetAllHolidayGroup(void* context, uint32_t deviceId, BS2HolidayGroup** holidayGroupObj, uint32_t* numHolidayGroup);
</code>

<callout type="info">
[[access control api#BS2HolidayGroup|See BS2HolidayGroup Structure]]
</callout>
==== Parameter ====
  * [In] ''//context//'' : Context
  * [In] ''//deviceId//'' : Device ID
  * [Out] ''//holidayGroupObj//'' : Holiday group list pointer
  * [Out] ''//numHolidayGroup//'' : Number of holiday groups
<WRAP indent>
<WRAP info 70%>
**NOTE**\\
The holidayGroupObj 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_GetHolidayGroup]]\\ [[BS2_SetHolidayGroup]]\\ [[BS2_RemoveHolidayGroup]]\\ [[BS2_RemoveAllHolidayGroup]]