Delete - 方法

概述

类型:

方法

适用的版本:

V1.0.0.0

G-SE-0078600.2.gif-high.gif

 

 

任务

方法 Delete 发起 HTTP 方法以删除指定资源。

功能描述

利用输入 i_sHost(必需)和 i_sResource,可创建 HTTP 请求的缺省标头。如果必须将附加信息添加到标头,则必须通过输入 i_anyAdditionalHeader 来传输这些信息。不对分配到此输入的数据进行验证。在输入 i_anyResponseBuffer 处,必须指定足够大小的缓冲区来完整存储从服务器接收的响应。

方法的返回值为类型 BOOL,它指示方法执行是成功 (TRUE) 还是失败 (FALSE)。如果返回值为 FALSE,则评估方法的诊断输出。这些输出指示的错误不需要复位。必须使用属性 State 来获取处理状态。

只有在状态 Connected 下,才能够调用方法 Delete

客户端的状态切换

阶段

描述

1

初始状态:Connected

2

功能调用

3

状态:SendingRequest,否则提示检测到错误

4

最终状态:ResponseAvailable,否则提示检测到错误

注意: 如果在功能块正处理 Delete 请求时执行在线修改,则执行会被中止,以免发生可能因处理错误指针地址导致的访问违例。

接口

输入

数据类型

描述

i_sResource

STRING[GPL.Gc_uiMaxLengthOfResource]

指定请求到达的主机资源。

i_sHost

STRING[GPL.Gc_uiMaxHostSize]

指定主机的地址;如有需要,还需指定端口。

i_anyAdditionalHeader

ANY_STRING

指定要添加到 HTTP 请求的附加标头。

i_anyContent

ANY

指定包含要与 HTTP 请求一起提交的内容的缓冲区。

i_udiContentLength

UDINT

内容的长度(字节)。

i_anyResponseBuffer

ANY

用于存储来自服务器的响应的缓冲区。

输出

数据类型

描述

q_xError

BOOL

如果此输出设置为 TRUE,则检测到错误。有关详细信息,请参阅 q_etResultq_etResultMsg

q_etResult

ET_Result

以数字值的形式提供诊断和状态信息。

q_sResultMsg

STRING[80]

以文本消息的形式提供附加的诊断和状态信息。