RedisClientZSetRangeAsync 方法 |
返回有序集 key 中,指定区间内的成员。其中成员的位置按 score 值递增(从小到大)来排序。具有相同 score 值的成员按字典序来排列。
下标参数 start 和 stop 都以 0 为底,也就是说,以 0 表示有序集第一个成员,以 1 表示有序集第二个成员,以此类推。你也可以使用负数下标,以 -1 表示最后一个成员, -2 表示倒数第二个成员,以此类推。
命名空间:
HslCommunication.Enthernet.Redis
程序集:
HslCommunication (在 HslCommunication.dll 中) 版本:12.1.2.0 (12.1.2.0)
语法 public Task<OperateResult<string[]>> ZSetRangeAsync(
string key,
int start,
int stop,
bool withScore = false
)
Public Function ZSetRangeAsync (
key As String,
start As Integer,
stop As Integer,
Optional withScore As Boolean = false
) As Task(Of OperateResult(Of String()))
public:
Task<OperateResult<array<String^>^>^>^ ZSetRangeAsync(
String^ key,
int start,
int stop,
bool withScore = false
)
member ZSetRangeAsync :
key : string *
start : int *
stop : int *
?withScore : bool
(* Defaults:
let _withScore = defaultArg withScore false
*)
-> Task<OperateResult<string[]>>
参数
- key
- 类型:SystemString
有序集合的关键字 - start
- 类型:SystemInt32
起始的下标 - stop
- 类型:SystemInt32
结束的下标 - withScore (Optional)
- 类型:SystemBoolean
是否带有 score 返回
返回值
类型:
TaskOperateResultString指定区间内,根据参数 withScore 来决定是否带 score 值的有序集成员的列表。
备注
超出范围的下标并不会引起错误。比如说,当 start 的值比有序集的最大下标还要大,或是 start > stop 时, ZRANGE 命令只是简单地返回一个空列表。另一方面,假如 stop 参数的值比有序集的最大下标还要大,那么 Redis 将 stop 当作最大下标来处理。
可以通过使用 WITHSCORES 选项,来让成员和它的 score 值一并返回,返回列表以 value1,score1, ..., valueN,scoreN 的格式表示。客户端库可能会返回一些更复杂的数据类型,比如数组、元组等。
参见