| 1 |
uniqueid requirements |
| 2 |
================= |
| 3 |
|
| 4 |
## Overview |
| 5 |
The UniqueIDs module provides pseudo unique identifiers to the rest of the modules |
| 6 |
|
| 7 |
## Exposed API |
| 8 |
```C |
| 9 |
#define UNIQUEID_RESULT_VALUES \ |
| 10 |
UNIQUEID_OK, \ |
| 11 |
UNIQUEID_INVALID_ARG, \ |
| 12 |
UNIQUEID_ERROR |
| 13 |
|
| 14 |
MU_DEFINE_ENUM(UNIQUEID_RESULT, UNIQUEID_RESULT_VALUES) |
| 15 |
|
| 16 |
extern UNIQUEID_RESULT UniqueId_Generate(char* uid, size_t bufferSize); |
| 17 |
``` |
| 18 |
### UniqueId_Generate |
| 19 |
```C |
| 20 |
extern UNIQUEID_RESULT UniqueId_Generate(char* uid, size_t len); |
| 21 |
``` |
| 22 |
**SRS_UNIQUEID_07_001: [** UniqueId_Generate shall create a unique Id 36 character long string. **]** |
| 23 |
|
| 24 |
**SRS_UNIQUEID_07_002: [** If uid is NULL then UniqueId_Generate shall return UNIQUEID_INVALID_ARG **]** |
| 25 |
|
| 26 |
**SRS_UNIQUEID_07_003: [** If len is less then 37 then UniqueId_Generate shall return UNIQUEID_INVALID_ARG **]** |
| 27 |
|
| 28 |
**SRS_UNIQUEID_07_004: [** If there is a failure for any reason the UniqueId_Generate shall return UNIQUEID_ERROR **]** |