cwbSV_GetTraceSPIType

Use the cwbSV_GetTraceSPIType API with this product.

Purpose

Returns the SPI event type of the service record object that is identified by the handle that is provided.

Syntax

 
unsigned int CWB_ENTRY cwbSV_GetTraceSPIType(
                             cwbSV_ServiceRecHandle  serviceRecHandle,
                             cwbSV_EventType        *eventType,
                             cwbSV_ErrHandle         errorHandle);

Parameters

cwbSV_ServiceRecHandle serviceRecHandle - input: Handle that was returned by a previous call to the cwbSV_CreateServiceRecHandle() function.
cwbSV_EventType * eventType - output: Pointer to a cwbSV_EventType where the eventType will be returned. - CWBSV_ENTRY_POINT - CWBSV_EXIT_POINT
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: Type is not CWBSV_SPI_TRACE_REC.
CWBSV_INVALID_EVENT_TYPE: Unusable event type detected.

Usage

If the record type is not CWBSV_SPI_TRACE_REC, a return code of CWBSV_INVALID_RECORD_TYPE will be returned. (note: cwbSV_GetServiceType() returns the current record type)