SCAProgram.h File Reference

Go to the source code of this file.

Functions

void SCAService (wchar_t *serviceName, int *compCode, int *reason)
void SCAOperation (wchar_t *operationName, int *compCode, int *reason)
void SCAMessageIn (wchar_t *serviceName, wchar_t *operationName, int *bufferLen, void *buffer, int *compCode, int *reason)
void SCAMessageOut (wchar_t *serviceName, wchar_t *operationName, int *bufferLen, void *buffer, int *compCode, int *reason)

Detailed Description

Copyright(C) OASIS(R) 2007,2010. All Rights Reserved. OASIS trademark, IPR and other policies apply.

This file contains the SCA API functions declarations for implementing components in programs.

Author:
SCA-C-C++ TC
Version:
1.1
Date:
4 March 2010

Function Documentation

void SCAMessageIn ( wchar_t *  serviceName,
wchar_t *  operationName,
int *  bufferLen,
void *  buffer,
int *  compCode,
int *  reason 
)

Retrieve the request message.

Parameters:
serviceName Name returned by SCAService().
operationName Name returned by SCAOperation().
bufferLen Input: Maximum number of bytes that can be returned. Output: Actual number of bytes returned or size needed to hold entire message.
buffer Request message.
compCode 
  • SCACC_OK, if the call is successful.
  • SCACC_WARNING, if the request data was truncated. The buffer size needs to be increased and the call repeated with the larger buffer.
reason SCA_DATA_TRUNCATED if the request data was truncated.
void SCAMessageOut ( wchar_t *  serviceName,
wchar_t *  operationName,
int *  bufferLen,
void *  buffer,
int *  compCode,
int *  reason 
)

Return a reply message.

Parameters:
serviceName Name returned by SCAService().
operationName Name returned by SCAOperation().
bufferLen Length of the reply message buffer.
buffer Reply message.
compCode SCACC_OK.
reason unused.
void SCAOperation ( wchar_t *  operationName,
int *  compCode,
int *  reason 
)

Determine which operation was used to invoke a component implementation.

Parameters:
operationName Name of the operation used to invoke the component.
compCode SCACC_OK
reason Unused
void SCAService ( wchar_t *  serviceName,
int *  compCode,
int *  reason 
)

Determine which service was used to invoke a component implementation.

Parameters:
serviceName Name of the service used to invoke the component.
compCode SCACC_OK
reason Unused

Service Component Architecture (SCA) Version 1.1 C API, CD05 March 2010  OASIS-Open.org