HttpClient.GetData Method (String, String)

Retrieve data from a web server and store it in a string buffer.

Parameters

resourceName

A string that specifies the resource on the server that will be accessed. If the resource specifies a file, then the contents of the file will be returned by the server. If the resource specifies a script or other executable content, it will be executed and the output will be transferred to the local system. The resource name should be specified using an absolute path that begins with a leading slash character.

buffer

A string passed by reference the data will be stored in.

Return Value

This method returns a Boolean value. If the method succeeds, the return value is true. If the method fails, the return value is false. To get extended error information, check the value of the LastError property.

Remarks

The GetData method transfers data from the server to the local system, storing it in a string buffer. This method will cause the current thread to block until the file transfer completes, a timeout occurs or the transfer is canceled. During the transfer, the OnProgress event will fire periodically, enabling the application to update any user interface objects such as a progress bar.

This version of the method should only be used when the data returned by the server contains readable text. By default, the text will be automatically converted to Unicode characters using UTF-8 encoding. The CodePage property can used to change how the text is converted.

See Also

HttpClient Class | SocketTools Namespace | HttpClient.GetData Overload List