TCPIP_HTTP_NET_DynamicWriteString Function

C

bool TCPIP_HTTP_NET_DynamicWriteString(
    const TCPIP_HTTP_DYN_VAR_DCPT* varDcpt, 
    const char* str, 
    bool needAck
);

Description

This function takes a 0 terminated ASCII string and sends it to the HTTP connection as part of the HTTP dynamic variable processing.

Preconditions

varDcpt - a valid dynamic variable descriptor.

Parameters

ParametersDescription
varDcptDynamic variable descriptor as passed in the template_DynPrint() function.
strThe string to be written.
needAckIf true, once the buffer is processed internally, template_DynAcknowledge() will be called.

Returns

  • True - Data buffer has been queued for output.

  • False - An invalid buffer was provided or the buffer could not be queued because of lack of resources (descriptors).

Remarks

This is just a helper. The actual function called is still TCPIP_HTTP_NET_DynamicWrite(). That means that the supplied string has to be persistent. See the remarks for TCPIP_HTTP_NET_DynamicWrite().