Salesforce

ClientDbDel (Magic xpa 4.x)

« Go Back

Information

 
Created BySalesforce Service User
Approval Process StatusPublished
Objective
Description

ClientDbDel (Magic xpa 4.x)

This client-side function deletes a local data source that appears in the Data repository, and returns a logical true or false indicating success or failure of the operation.

Syntax:

ClientDbDel(number,file name)

Parameters:

number – A number that represents the data source's sequence number in the Data repository.

file name – This parameter is used as an alternative to number. If not needed, enter '' (two single quotation marks). If needed, enter an Alpha string that represents the data source specification. The string may contain a path. If the path is not indicated, Magic xpa assumes the current directory.

Returns:

Boolean (True, False)

Examples:

ClientDbDel(1,'') or ClientDbDel('1'DSOURCE,'') attempts to delete the first local data source from the Data repository and returns TRUE if the operation is successful.

Usage:

This is useful when you want to do a clean sync of data, usually between the server and the client.

Note:

This is a client-side function that is only available for Rich Client tasks.

Using the DSOURCE literal will ensure that the correct data source will be deleted even if the data source's position in the Data repository has changed. The data source's sequence number and path behave exactly as defined in the Data repository.

To delete a server data source, see DbDel.

Exceptions:

This function is not supported in Web Client tasks.

Since version: 2.4b

Reference
Attachment 
Attachment