PLCnext API Documentation 23.6.0.37
GdsBuffer.h
1/******************************************************************************
2 *
3 * Copyright PHOENIX CONTACT Electronics GmbH
4 *
5 *****************************************************************************/
6#ifndef __ARPPLCGDSBUFFER_H__
7#define __ARPPLCGDSBUFFER_H__
8
9/*************************************************************************/
10/* INCLUDES */
11/*************************************************************************/
12#include "Arp/Plc/AnsiC/ArpPlc.h"
13
14
15/*************************************************************************/
16/* TYPE DEFINITIONS */
17/*************************************************************************/
18#ifdef __cplusplus
19namespace Arp { namespace Plc { namespace Commons { namespace Gds
20{
21class IGdsBuffer;
22}}}} // namespace Arp::Plc::Commons::Gds
23using TGdsBuffer = Arp::Plc::Commons::Gds::IGdsBuffer;
24#else
25typedef struct TGdsBuffer TGdsBuffer;
26#endif /*__cplusplus*/
27
28/*************************************************************************/
29/* GLOBAL FUNCTION DECLARATIONS (EXTERNAL) */
30/*************************************************************************/
31#ifdef __cplusplus
32extern "C"
33{
34#endif /*__cplusplus*/
35
47extern ARP_C_SYMBOL_EXPORT bool ArpPlcGds_BeginRead(
48 TGdsBuffer* pGdsBuffer, char** pOutCurrentReadData);
49
57extern ARP_C_SYMBOL_EXPORT bool ArpPlcGds_EndRead(TGdsBuffer* pGdsBuffer);
58
69extern ARP_C_SYMBOL_EXPORT bool ArpPlcGds_BeginWrite(
70 TGdsBuffer* pGdsBuffer, char** pOutCurrentWriteData);
71
80extern ARP_C_SYMBOL_EXPORT bool ArpPlcGds_EndWrite(TGdsBuffer* pGdsBuffer);
81
90extern ARP_C_SYMBOL_EXPORT bool ArpPlcGds_EndWriteDataInvalid(TGdsBuffer* pGdsBuffer);
91
92#ifdef __cplusplus
93} /*extern "C"*/
94#endif /*__cplusplus*/
95
96#endif /*__ARPPLCGDSBUFFER_H__*/
Root namespace for the PLCnext API