Home | Previous Page | Next Page   Large Object Locator DataBlade Module > Functions > Client File Support >

lld_delete_client()

This function deletes the specified client file.

Syntax

API
mi_integer lld_delete_client(conn, path, error)
   MI_CONNECTION*               conn; 
   mi_string*                   path;
   mi_integer*                  error; 
ESQL/C
int lld_delete_client (char* path,int* error); 
conn
is the connection descriptor established by a previous call to the mi_open() or mi_server_connect() functions. This parameter is for the API interface only. In the ESQL/C version of this function, you must already be connected to a server.
path
is a pointer to the pathname of the client file.
error
is an output parameter in which the function returns an error code.

Usage

This function deletes the specified client file and reclaims any allocated resources.

Return Codes

For an API function, returns MI_OK if the function succeeds and MI_ERROR if it fails.

For an ESQL/C function, returns 0 if the function succeeds and -1 if the function fails.

Context

lld_create_client(), page lld_create_client()

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]