PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Properties specific to the description of redisResponse variables
  • WLanguage functions that use the redisResponse type
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
redisResponse (Type of variable)
In french: redisRéponse
The redisResponse type makes it possible to define all the advanced characteristics of a response received by RedisExecuteCommand or RedisPipelineGet. The characteristics of this response can be known using different WLanguage properties.
Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.
Example
INTERNAL PROCEDURE DisplayResult (r is redisResponse, sIdent="")
SWITCH r.Type
CASE redisTypeInt
Trace(sIdent + "integer: " + r.Integer)
CASE redisTypeError
Trace(sIdent + "error: " + r.String)
CASE redisTypeStatus
Trace(sIdent + "status: " + r.String)
CASE redisTypeNil
Trace(sIdent + "Nil")
CASE redisTypeArray
Trace(sIdent + "array: ")
FOR EACH r2 OF r.Array
ShowResponse(r2, sIdent + TAB)
END
CASE redisTypeBuffer
Trace(sIdent + "buffer in string: " + r.String)
Trace(sIdent + "buffer in hexa: " + BufferToHexa(r.Buffer))
END
END
 
r1 is redisResponse = RedisExecuteCommand(gRedis, "GET keyString")
DisplayResult(r1)
Remarks

Properties specific to the description of redisResponse variables

The following properties can be used to handle a Redis response:
Property nameType usedEffect
ArrayArray of redisResponseIf the Type property corresponds to the redisTypeArray constant, this property contains an array of redisResponse variables.
BufferBufferBinary value if the Type property corresponds to the redisTypeBuffer constant.
This property is read-only.
IntegerIntegerInteger value if the Type property corresponds to the redisTypeInt constant.
This property is read-only.
StringCharacter string
  • If the Type property corresponds to the redisTypeStatus constant, it contains the string corresponding to the returned state.
  • If the Type property corresponds to the redisTypeError constant, it contains the error message.
  • If the Type property corresponds to the redisTypeBuffer constant, it contains the buffer converted to a string using UTF-8 encoding.
This property is read-only.
TypeIntegerType of the result. This type can correspond to one of the following constants:
  • redisTypeBuffer: The result corresponds to a buffer.
  • redisTypeInt: The result corresponds to an integer.
  • redisTypeError: The result corresponds to an error.
  • redisTypeNil: The result has no value.
  • redisTypeStatus: The result corresponds to a status.
  • redisTypeArray: The result corresponds to an array.
This property is read-only.

WLanguage functions that use the redisResponse type

Versions 24 and later
RedisExecuteCommand
New in version 24
RedisExecuteCommand
RedisExecuteCommand
Executes a command on a Redis server and retrieves the result.
Versions 24 and later
RedisPipelineGet
New in version 24
RedisPipelineGet
RedisPipelineGet
Retrieves the result of the execution of a Redis command that was added by RedisPipelineAdd.
Minimum version required
  • Version 24
This page is also available for…
Comments
Click [Add] to post a comment