cwbSV_GetTraceSPIID

Purpose

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

Syntax

 
unsigned int CWB_ENTRY cwbSV_GetTraceSPIID(
                             cwbSV_ServiceRecHandle  serviceRecHandle,
                             char                   *spiID);

Parameters

cwbSV_ServiceRecHandle serviceRecHandle - input

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

char * spiID - input/output

Pointer to one-byte field that receives the SPI event ID.

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.

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)