GetUserData
Applicability
Product |
Supported |
|---|---|
√ |
|
√ |
|
x |
|
x |
|
x |
Function Description
Obtains user information.
Prototype
1 | Status GetUserData(void *data, size_t size, size_t offset = 0U) const |
Parameters
Parameter |
Input/Output |
Description |
|---|---|---|
data |
Input/Output |
Pointer to the user data. |
size |
Input |
Length of the user data. Value range: (0, 64]. |
offset |
Input |
Offset of the user data, which must comply with the following restriction: Value range: [0, 64); size + offset ≤ 64 |
Returns
- 0: success
- Other values: failure
Exception Handling
None
Constraints
None
The values of size and offset of this API must be the same as those of size and offset in SetUserData.
Parent topic: DataFlowInfo Data Types