CharacteristicUserDescription Property

The value of the user description descriptor for this characteristic.

Syntax

• C++

ANSI (Cross Platform)
char* GetCharacteristicUserDescription(int iCharacteristicIndex);
int SetCharacteristicUserDescription(int iCharacteristicIndex, const char* lpszCharacteristicUserDescription);

Unicode (Windows)
LPWSTR GetCharacteristicUserDescription(INT iCharacteristicIndex);
INT SetCharacteristicUserDescription(INT iCharacteristicIndex, LPCWSTR lpszCharacteristicUserDescription);

#define PID_BLECLIENT_CHARACTERISTICUSERDESCRIPTION 10

IPWORKSBLE_EXTERNAL void* IPWORKSBLE_CALL IPWorksBLE_BLEClient_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSBLE_EXTERNAL int IPWORKSBLE_CALL IPWorksBLE_BLEClient_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKSBLE_EXTERNAL int IPWORKSBLE_CALL IPWorksBLE_BLEClient_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

""

Remarks

The value of the user description descriptor for this characteristic.

If the "Writable Auxiliaries" property is set for this characteristic, you can change this value, which updates it on the server too.

Note that, on some platforms, the class might have to automatically discover specific descriptors for the value this returns to be accurate. The class take care of handling this automatic discovery in the most energy-efficient manner possible.

The CharacteristicIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CharacteristicCount property.

This property is not available at design time.

Data Type

String