CLC_Fct_DataTransferMessage.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_DataTransferMessage.h
// Project:         CopperLan CHAILink Client SDK
// Version:         1.3
// Release Date:    2014/04/15
//*********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef _CLC_FCT_DATATRANSFERTMESSAGE_H_
#define _CLC_FCT_DATATRANSFERTMESSAGE_H_

#ifdef __cplusplus
extern "C" {
#endif


CLC_SDK_API CLC_ErrorCode DataTransferMessage_SetNumber(
    CPHOOKEDOBJECT const hMsg, 
    CPUINT16 const wNumber);

CLC_SDK_API CLC_ErrorCode DataTransferMessage_GetNumber(
    CPHOOKEDOBJECT const hMsg, 
    CPUINT16 * const pwNumber);


CLC_SDK_API CLC_ErrorCode DataTransferMessage_GetSendBufferLength(
    CPHOOKEDOBJECT const hMsg, 
    CPUINT16 * const pwSendBufferLength);

CLC_SDK_API CLC_ErrorCode DataTransferMessage_SetSendBuffer(
    CPHOOKEDOBJECT const hMsg, 
    CPUINT16 const wToOffset,
    CPUINT16 const wBytesToCopy, 
    CPBYTE const * const pSrcBuffer);


CLC_SDK_API CLC_ErrorCode DataTransferMessage_GetReceiveBufferLength(
    CPHOOKEDOBJECT const hMsg, 
    CPUINT16 * const pwReceiveBufferLength);

CLC_SDK_API CLC_ErrorCode DataTransferMessage_GetReceiveBuffer(
    CPHOOKEDOBJECT const hMsg, 
    CPUINT16 const wFromOffset,
    CPUINT16 const wBytesToRead,
    CPUINT16 * const pwBytesRead,
    CPBYTE const ** const ppBuffer);


#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_DATATRANSFERTMESSAGE_H_