ReadFromWeb - method of the PmaDataTable object

Description:

Reading the data from Web server in the XML format into this object.

Syntax:

Boolean ReadFromWeb(String URL, String sParam)

Parameters:

URL

URL	(String) The URL address of the data Web server where the XML data are stored. The PROMOTIC application as the Web server offers the data usually on the path (see the "PmaDataTable > Web server" tab): `http://ComputerName:Port/ComponentId/data.xml?fmt=purevalue` Caution! Beginning of the address ("http:") must be entered! If you want to enter the address of the local computer, then it is possible to enter the localhost word as the ComputerName. The Port needn't be entered if the Web server is on the standard port 80. The communication also works on secured Web server at address https://...
sParam	(String) Additional parameters of the transfer. This is the text in the form, for example "user:NAME1;psw:PASSWORD1;". If no parameter is needed, then an empty string "" can be entered. user - User name for the authentication. See "WebRead" permission on the server. If not set and the site requires the authentication, then the onEndOfTransfer event is triggered with the error pEvent.Error=62. psw - Password of the user for the authentication. This parameter is ignored if the user parameter is missing.

(String) The URL address of the data Web server where the XML data are stored. The PROMOTIC application as the Web server offers the data usually on the path (see the "PmaDataTable > Web server" tab):

http://ComputerName:Port/ComponentId/data.xml?fmt=purevalue

Caution! Beginning of the address ("http:") must be entered! If you want to enter the address of the local computer, then it is possible to enter the localhost word as the ComputerName. The Port needn't be entered if the Web server is on the standard port 80.
The communication also works on secured Web server at address https://...

sParam

(String) Additional parameters of the transfer.
This is the text in the form, for example "user:NAME1;psw:PASSWORD1;".
If no parameter is needed, then an empty string "" can be entered.

user - User name for the authentication. See "WebRead" permission on the server.
If not set and the site requires the authentication, then the onEndOfTransfer event is triggered with the error pEvent.Error=62.

psw - Password of the user for the authentication.
This parameter is ignored if the user parameter is missing.

Return value:

true - The method successfully queued the request for reading data from server. After data transfer the onEndOfTransfer event is triggered.

false - The method hasn't queued the request for reading data. Probably the previous request about sending/receiving of this object hasn't been finished yet. The onEndOfTransfer event is not triggered.

Note:

This method is not functional for PmFree.

By calling ReadFromWeb method over the object, this object is regarded as the Web client that reads data from the component of the Web server - in this case from another but the same configured PmaDataTable object in another application on the same or another computer.
The method only activates the data transfer but there is no assurance that data are already transferred after ending this method. The data transfer termination is announced by the the onEndOfTransfer event. During the data transfer (i.e. in the time after calling the ReadFromWeb method and before the onEndOfTransfer event is triggered) neither ReadFromWeb method nor the WriteToWeb method can be called over the object again - then the method returns the false value. By means of the WebClientIsReady property it can be found out if the object is ready for the next transfer.

The client cannot change the data amount assigned to him by the ReadFromWeb method - for example, by reading more data than it is set. If this is requested, then The client itself has to make this change first - see the description in chapter XML data sharing.

"Read only" columns: Each cell is empty at the beginning. The cell is considered empty also if it contains numeric value 0 or an empty string "". New value can be written into such cell. After writing a non-zero value into the "Read only" column the cell is "locked". "Locked cell" becomes a constant and cannot be written again. Other still "unlocked" cells can be written into as needed. Methods that write into multiple cells simultaneously will write the values only into "unlocked cells" while the content of "locked" cells remains unchanged.

Example:

JavaScriptVBScriptSelect and copy to clipboard



var oDataTable = pMe.Pm("/DataTable");

if (oDataTable.WebClientIsReady)

{

	oDataTable.ReadFromWeb("http://ComputerName:Port/ComponentId/data.xml?fmt=purevalue", "user:oper;psw:ABCD;");

}

else

{

	Pm.Debug("Web client PARAM is not ready (is still active)");

}