PageControl DataObject
PageControl 使您的应用程序可以检索搜索结果的其他页面。
PageControl 数据对象的结构由以下内容组成:
- 大小
- 指示页面的大小。
- cookie
- 包含从 PageResponseControl 返回的 cookie,以使服务器能够获取下一个要搜索的页面。 对于首次调用页面调度搜索,此属性不会设置为任何值。
笔记:如果countLimit属性指定为SearchControl,PageControl不能使用。 它们是互斥的。
XML 模式定义
以下是 PageControl 数据对象的 XML 模式定义:
<xsd:complexType name="PageControl">
<xsd:complexContent>
<xsd:extension base="Control">
<xsd:attribute name="size" type="xsd:int"/>
<xsd:attribute name="cookie" type="xsd:hexBinary"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
样本数据对象
以下是在第一个页面的搜索 API 中使用的样本 PageControl 数据对象。 此数据对象中没有 cookie 属性。 其指示仅返回 10 个结果,即使搜索结果大于 10 个。
<controls xsi:type="PageControl" size="10"/>以下是在后续页面的搜索 API 中使用的样本 PageControl 数据对象。 设置了从 PageResponseControl 返回的 cookie 属性。
<wim:controls xsi:type="wim:PageControl"
cookie="57494D53656172636843616368654E616D6574696D653A31313239353538343136383636"
size="10"/>
以下是搜索 API 中使用的一个样本 PageControl 数据对象,用以指示停止搜索。 要停止对搜索结果进行页面调度,请在设置了 cookie 的情况下将页面大小设置为 0。
<wim:controls xsi:type="wim:PageControl"
cookie="57494D53656172636843616368654E616D6574696D653A31313239353538343136383636"
size="0"/>