RequestOptionValueType Property
The option's value data type.
Syntax
ANSI (Cross Platform) int GetRequestOptionValueType(int iRequestOptionIndex);
int SetRequestOptionValueType(int iRequestOptionIndex, int iRequestOptionValueType); Unicode (Windows) INT GetRequestOptionValueType(INT iRequestOptionIndex);
INT SetRequestOptionValueType(INT iRequestOptionIndex, INT iRequestOptionValueType);
Possible Values
OVT_STRING(0),
OVT_UINT(1),
OVT_BINARY(2)
- (int)requestOptionValueType:(int)requestOptionIndex; - (void)setRequestOptionValueType:(int)requestOptionIndex:(int)newRequestOptionValueType;
Possible Values
OVT_STRING(0),
OVT_UINT(1),
OVT_BINARY(2)
#define PID_COAP_REQUESTOPTIONVALUETYPE 20 IPWORKSIOT_EXTERNAL void* IPWORKSIOT_CALL IPWorksIoT_CoAP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal); IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_CoAP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal); IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_CoAP_CheckIndex(void *lpObj, int propid, int arridx);
Default Value
0
Remarks
The option's value data type.
This property specifies the data type of the option's RequestOptionValue. If RequestOptionNumber is set to a recognized value (refer to the table in its documentation), this property will automatically be set to the correct value. The table below shows the possible value types, their descriptions, and how to format the data assigned to RequestOptionValue.
Type | Description | Value Format |
ovtString (0) (default) | String | String |
ovtUInt (1) | Unsigned integer | 0 to 4294967295 |
ovtBinary (2) | Binary data | Hex-encoded byte string |
The RequestOptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestOptionCount property.
This property is not available at design time.
Data Type
Integer