cwbSV_GetComponent

Purpose

Returns the component ID value for the service record object that is identified by the handle provided.

Syntax

 
unsigned int CWB_ENTRY cwbSV_GetComponent(
                             cwbSV_ServiceRecHandle  serviceRecHandle,
                             char                   *componentID,
                             unsigned long           componentIDLength,
                             unsigned long          *returnLength);

Parameters

cwbSV_ServiceRecHandle serviceRecHandle - input

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

char * componentID - input/output

Pointer to a buffer that will receive the component ID that is stored in the record that is identified by the handle.

unsigned long componentIDLength - input

Length of the receive buffer passed in. It should include space for the ending null character. If the buffer is too small, the value will be truncated, and CWB_BUFFER_OVERFLOW and returnLength will be set. NOTE: The recommended size is CWBSV_MAX_COMP_ID.

unsigned long * returnLength - input/output

Optional, may be NULL. A return address to store the number of bytes needed to hold the output string if the receive buffer is too small.

Return Codes

The following list shows common return values.

CWB_OK

Successful completion.

CWB_BUFFER_OVERFLOW

Output buffer too small, data truncated.

CWB_INVALID_POINTER

NULL passed on output parameter.

CWB_INVALID_HANDLE

Handle is not valid.

Usage

The service record handle needs to be filled in by a call to a "read" function before calling this routine, otherwise a NULL string will be returned. This function is valid for all service record types.