cwbSV_ClearServiceFile

Purpose

Clears the service file that is identified by the handle that is provided.

Syntax

 
unsigned int CWB_ENTRY cwbSV_ClearServiceFile(
                             cwbSV_ServiceFileHandle serviceFile,
                             cwbSV_ErrHandle         errorHandle);

Parameters

cwbSV_ServiceFileHandle serviceFileHandle - input

Handle that was returned by a previous call to the cwbSV_OpenServiceFile() function.

cwbSV_ErrHandle errorHandle - output

Any returned messages will be written to this object. It is created with the cwbSV_CreateErrHandle API. The messages may be retrieved through the cwbSV_GetErrText API. If the parameter is set to zero, no messages will be retrieved.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_FILE_IO_ERROR

File could not be cleared.

CWB_INVALID_HANDLE

Handle is not valid.

Usage

None