RequestOptionValue Property

The option's value.

Syntax

ANSI (Cross Platform)
char* GetRequestOptionValue(int iRequestOptionIndex);
int SetRequestOptionValue(int iRequestOptionIndex, const char* lpszRequestOptionValue);

Unicode (Windows)
LPWSTR GetRequestOptionValue(INT iRequestOptionIndex);
INT SetRequestOptionValue(INT iRequestOptionIndex, LPCWSTR lpszRequestOptionValue);

- (NSString*)requestOptionValue:(int)requestOptionIndex;
- (void)setRequestOptionValue:(int)requestOptionIndex:(NSString*)newRequestOptionValue;

#define PID_COAP_REQUESTOPTIONVALUE 19

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

Remarks

The option's value.

This property specifies the option's value. The RequestOptionValueType property specifies the data type of the value.

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

String

IPWorks IoT 2020 C++ Edition Website Download Support Questions / Feedback?
IPWorks IoT 2020 C++ Edition Introduction Licensing Instructions AMQP Class Introduction Properties AuthScheme Connected ContainerId FetchTimeout FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser IdleTimeout IncomingMessageCount IncomingMessageAbsoluteExpiryTime IncomingMessageContentEncoding IncomingMessageContentType IncomingMessageCorrelationId IncomingMessageCreationTime IncomingMessageDeliveryCount IncomingMessageDurable IncomingMessageFirstAcquirer IncomingMessageGroupId IncomingMessageGroupSequence IncomingMessageLinkName IncomingMessageId IncomingMessagePriority IncomingMessageReplyTo IncomingMessageReplyToGroupId IncomingMessageSettled IncomingMessageSubject IncomingMessageTo IncomingMessageTTL IncomingMessageUserId IncomingMessageValue IncomingMessageValueType LinkCount LinkAvailable LinkChannelName LinkCredit LinkDeliveryCount LinkName LinkReadyToSend LinkReceiveMode LinkRole LocalHost LocalPort MessageAbsoluteExpiryTime MessageContentEncoding MessageContentType MessageCorrelationId MessageCreationTime MessageDeliveryCount MessageDurable MessageFirstAcquirer MessageGroupId MessageGroupSequence MessageLinkName MessageId MessagePriority MessageReplyTo MessageReplyToGroupId MessageSettled MessageSubject MessageTo MessageTTL MessageUserId MessageValue MessageValueType OutgoingMessageCount OutgoingMessageAbsoluteExpiryTime OutgoingMessageContentEncoding OutgoingMessageContentType OutgoingMessageCorrelationId OutgoingMessageCreationTime OutgoingMessageDeliveryCount OutgoingMessageDurable OutgoingMessageFirstAcquirer OutgoingMessageGroupId OutgoingMessageGroupSequence OutgoingMessageLinkName OutgoingMessageId OutgoingMessagePriority OutgoingMessageReplyTo OutgoingMessageReplyToGroupId OutgoingMessageSettled OutgoingMessageSubject OutgoingMessageTo OutgoingMessageTTL OutgoingMessageUserId OutgoingMessageValue OutgoingMessageValueType Password ReadyToSend ReceivedMessageAbsoluteExpiryTime ReceivedMessageContentEncoding ReceivedMessageContentType ReceivedMessageCorrelationId ReceivedMessageCreationTime ReceivedMessageDeliveryCount ReceivedMessageDurable ReceivedMessageFirstAcquirer ReceivedMessageGroupId ReceivedMessageGroupSequence ReceivedMessageLinkName ReceivedMessageId ReceivedMessagePriority ReceivedMessageReplyTo ReceivedMessageReplyToGroupId ReceivedMessageSettled ReceivedMessageSubject ReceivedMessageTo ReceivedMessageTTL ReceivedMessageUserId ReceivedMessageValue ReceivedMessageValueType ReceiveMode RemoteHost RemotePort SessionCount SessionIncomingWindow SessionName SessionOutgoingWindow SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Timeout User Methods CloseLink CloseSession Config Connect CreateReceiverLink CreateSenderLink CreateSession Disconnect DoEvents FetchMessage Interrupt Reset ResetMessage SendMessage Events Connected ConnectionStatus Disconnected Error LinkReadyToSend Log MessageIn MessageOut MessageOutcome SSLServerAuthentication SSLStatus Configuration Error Codes AMQPClassic Class Introduction Properties ArgumentCount ArgumentName ArgumentValue ArgumentValueType AuthScheme ChannelCount ChannelAccept ChannelMode ChannelName ChannelReadyToSend ClientPropertyCount ClientPropertyName ClientPropertyValue ClientPropertyValueType Connected FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser Heartbeat IncomingMessageCount IncomingMessageAppId IncomingMessageBody IncomingMessageChannelName IncomingMessageContentEncoding IncomingMessageContentType IncomingMessageCorrelationId IncomingMessageDeliveryMode IncomingMessageExpiration IncomingMessageHeaders IncomingMessageId IncomingMessagePriority IncomingMessageReplyTo IncomingMessageTimestamp IncomingMessageType IncomingMessageUserId LocalHost LocalPort MessageAppId MessageBody MessageChannelName MessageContentEncoding MessageContentType MessageCorrelationId MessageDeliveryMode MessageExpiration MessageHeaders MessageId MessagePriority MessageReplyTo MessageTimestamp MessageType MessageUserId OutgoingMessageCount OutgoingMessageAppId OutgoingMessageBody OutgoingMessageChannelName OutgoingMessageContentEncoding OutgoingMessageContentType OutgoingMessageCorrelationId OutgoingMessageDeliveryMode OutgoingMessageExpiration OutgoingMessageHeaders OutgoingMessageId OutgoingMessagePriority OutgoingMessageReplyTo OutgoingMessageTimestamp OutgoingMessageType OutgoingMessageUserId Password QueueMessageCount ReceivedMessageAppId ReceivedMessageBody ReceivedMessageChannelName ReceivedMessageContentEncoding ReceivedMessageContentType ReceivedMessageCorrelationId ReceivedMessageDeliveryMode ReceivedMessageExpiration ReceivedMessageHeaders ReceivedMessageId ReceivedMessagePriority ReceivedMessageReplyTo ReceivedMessageTimestamp ReceivedMessageType ReceivedMessageUserId RemoteHost RemotePort ServerPropertyCount ServerPropertyName ServerPropertyValue ServerPropertyValueType SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Timeout User VirtualHost Methods BindQueue CancelConsume CloseChannel CommitTransaction Config Connect Consume CreateChannel DeclareExchange DeclareQueue DeleteExchange DeleteQueue Disconnect DoEvents EnablePublishConfirms EnableTransactionMode FetchMessage Interrupt PublishMessage PurgeQueue Recover Reset ResetMessage RollbackTransaction SetChannelAccept SetQoS UnbindQueue Events ChannelReadyToSend Connected ConnectionStatus Disconnected Error Log MessageIn MessageOut MessageReturned SSLServerAuthentication SSLStatus Configuration Error Codes CoAP Class Introduction Properties Listening LocalHost LocalPort PendingRequestCount PendingRequestMethod PendingRequestRemoteHost PendingRequestRemotePort PendingRequestId PendingRequestToken PendingRequestURI RequestContentFormat RequestData RequestETag RequestOptionCount RequestOptionCritical RequestOptionNoCacheKey RequestOptionNumber RequestOptionUnsafe RequestOptionValue RequestOptionValueType ResponseCode ResponseContentFormat ResponseData ResponseETag ResponseOptionCount ResponseOptionCritical ResponseOptionNoCacheKey ResponseOptionNumber ResponseOptionUnsafe ResponseOptionValue ResponseOptionValueType Timeout UseConfirmableMessages Methods CancelRequest Config Delete DoEvents Get Post Put Reset SendCustomRequest SendNotification SendResponse StartObserving StopObserving Events Error Log Notification Register Request RequestComplete ResponseComplete Unregistered Configuration Error Codes JSON Class Introduction Properties BuildDOM InputData InputFile OutputData OutputFile Overwrite Validate XChildCount XChildName XChildXText XElement XElementType XErrorPath XParent XPath XSubTree XText Methods Config EndArray EndObject Flush HasXPath InsertProperty InsertValue LoadSchema Parse PutName PutProperty PutRaw PutValue Remove Reset Save SetInputStream SetName SetOutputStream SetValue StartArray StartObject TryXPath Events Characters EndDocument EndElement Error IgnorableWhitespace JSON StartDocument StartElement Types IPWorksIoTStream Configuration Error Codes MQTT Class Introduction Properties CleanSession ClientId Connected FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser IncomingMessageCount IncomingMessageContentType IncomingMessageCorrelationData IncomingMessageDuplicate IncomingMessageMessage IncomingMessageMessageExpInterval IncomingMessagePacketId IncomingMessagePayloadFormatIndicator IncomingMessageQoS IncomingMessageResponseTopic IncomingMessageRetained IncomingMessageState IncomingMessageSubscriptionIdentifiers IncomingMessageTopic IncomingMessageTopicAlias KeepAliveInterval LocalHost LocalPort OutgoingMessageCount OutgoingMessageContentType OutgoingMessageCorrelationData OutgoingMessageDuplicate OutgoingMessageMessage OutgoingMessageMessageExpInterval OutgoingMessagePacketId OutgoingMessagePayloadFormatIndicator OutgoingMessageQoS OutgoingMessageResponseTopic OutgoingMessageRetained OutgoingMessageState OutgoingMessageSubscriptionIdentifiers OutgoingMessageTopic OutgoingMessageTopicAlias Password ReadyToSend RemoteHost RemotePort SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded Timeout User Version WillMessage WillTopic Methods Config Connect Disconnect DoEvents Interrupt PublishData PublishMessage Reset RestoreSession SaveSession Subscribe Unsubscribe Events Connected ConnectionStatus Disconnected Error Log MessageAck MessageIn MessageOut ReadyToSend SSLServerAuthentication SSLStatus Subscribed Unsubscribed Configuration Error Codes MQTTSN Class Introduction Properties CleanSession ClientId Connected KeepAliveInterval LocalHost LocalPort RemoteHost RemotePort Timeout WillMessage WillTopic Methods Config Connect Disconnect DiscoverGateway DoEvents FetchMessages Ping PublishData PublishMessage RegisterTopic Reset SendDiscoverResponse StartSleep StopSleep Subscribe Unsubscribe UpdateWillMessage UpdateWillTopic Events Connected Disconnected DiscoverRequest Error GatewayInfo Log MessageIn TopicInfo Configuration Error Codes STOMP Class Introduction Properties Connected ContentType FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser HeaderCount HeaderKey HeaderValue IncomingHeartbeat LocalHost LocalPort OutgoingHeartbeat ParsedHeaderCount ParsedHeaderKey ParsedHeaderValue Password ReadyToSend RemoteHost RemotePort RequestReceipts SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SubscriptionCount SubscriptionDestination SubscriptionId Timeout TransactionId User Methods AbortTransaction AddHeader BeginTransaction CommitTransaction Config Connect Disconnect DoEvents Interrupt Reset ResetHeaders SendData SendMessage Subscribe Unsubscribe Events Connected ConnectionStatus Disconnected Error Log MessageIn MessageOut ReadyToSend ReceiptIn ReceiptOut SSLServerAuthentication SSLStatus Subscribed Unsubscribed Configuration Error Codes XMPP Class Introduction Properties AuthDomain AuthMethods BuddyCount BuddyGroup BuddyId BuddyNickName BuddyRealName BuddySubscription Connected FirewallAutoDetect FirewallType FirewallHost FirewallPassword FirewallPort FirewallUser IMPort IMServer LocalDirectory LocalFile LocalHost MessageHTML MessageOtherData MessageSubject MessageText MessageThread MessageType Password Presence Resource ServerDomain SSLAcceptServerCertEncoded SSLCertEncoded SSLCertStore SSLCertStorePassword SSLCertStoreType SSLCertSubject SSLEnabled SSLServerCertEncoded SSLStartMode Status Timeout User UserDomain UserInfoCount UserInfoField UserInfoValue Methods Add Cancel ChangePassword ChangePresence Config Connect Disconnect DoEvents Interrupt ProbePresence QueryRegister Register Remove Reset RetrieveRoster SendCommand SendFile SendMessage SetUserInfoField SubscribeTo Unregister UnsubscribeTo Events BuddyUpdate Connected ConnectionStatus Disconnected EndTransfer Error IQ MessageIn PITrail Presence ReadyToSend SSLServerAuthentication SSLStatus StartTransfer SubscriptionRequest Sync Transfer Configuration Error Codes Software License	RequestOptionValue Property The option's value. Syntax C++ Objective-C C ANSI (Cross Platform) char* GetRequestOptionValue(int iRequestOptionIndex); int SetRequestOptionValue(int iRequestOptionIndex, const char* lpszRequestOptionValue); Unicode (Windows) LPWSTR GetRequestOptionValue(INT iRequestOptionIndex); INT SetRequestOptionValue(INT iRequestOptionIndex, LPCWSTR lpszRequestOptionValue); *- (NSString)requestOptionValue:(int)requestOptionIndex; - (void)*setRequestOptionValue:(int)requestOptionIndex:(NSString)newRequestOptionValue; #define PID_COAP_REQUESTOPTIONVALUE 19 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 "" Remarks The option's value. This property specifies the option's value. The RequestOptionValueType property specifies the data type of the value. 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 String
Copyright (c) 2022 /n software inc. - All rights reserved. IPWorks IoT 2020 C++ Edition - Version 20.0 [Build 8265]

IPWorks IoT 2020 C++ Edition

RequestOptionValue Property

Syntax

Default Value

Remarks

Data Type

Questions / Feedback?