cwbSV_GetServiceType

Use the cwbSV_GetServiceType API with this product.

Purpose

Returns the type of record (trace, message, entry/exit, and so forth) for the service record that is identified by the handle that is provided. Note: The service record needs to be filled in by a call to a "read" function before calling this function.

Syntax

 
unsigned int CWB_ENTRY cwbSV_GetServiceType(
                             cwbSV_ServiceRecHandle  serviceRecHandle,
                             cwbSV_ServiceRecType   *serviceType,
                             cwbSV_ErrHandle         errorHandle);

Parameters

cwbSV_ServiceRecHandle serviceRecHandle - input: Handle that was returned by a previous call to the cwbSV_CreateServiceRecHandle function.
cwbSV_ServiceRecType * serviceType - output: Pointer to a cwbSV_ServiceRecType where the serviceType will be returned. - CWBSV_MESSAGE_REC - CWBSV_PROBLEM_REC - CWBSV_DATA_TRACE_REC - CWBSV_API_TRACE_REC - CWBSV_SPI_TRACE_REC
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_INVALID_POINTER: NULL passed on output parameter.
CWB_INVALID_HANDLE: Handle is not valid.
CWBSV_INVALID_RECORD_TYPE: Unusable record type detected.

Usage

The service record handle needs to be filled in by a call to a "read" function before calling this routine, otherwise CWBSV_INVALID_RECORD_TYPE will be returned.