OpenClovis Logo

Files | Macros | Functions
API Reference Pages
External Data Representation (XDR)

Defines, Structures, Typedefs, Functions. More...

Files

file  clXdrApi.h
 Header file of XDR and IDL related APIs.

Macros

#define clXdrMarshallArrayClInt32T(pPyld, count, msg, isDelete)
 Marshall array of ClInt32T type.
#define clXdrMarshallArrayClInt64T(pPyld, count, msg, isDelete)
 Marshall array of ClInt64T type.
#define clXdrMarshallArrayClNameT(pointer, multiplicity, msg, isDelete)
 Marshall array of ClNameT type.
#define clXdrMarshallArrayClUint32T(pPyld, count, msg, isDelete)
 Marshall array of ClUint32T type.
#define clXdrMarshallArrayClUint64T(pPyld, count, msg, isDelete)
 Marshall array of ClUint64T type.
#define clXdrMarshallPtrClHandleT(pointer, multiplicity, msg, isDelete)
 Marshall pointer of ClHandleT type.
#define clXdrMarshallPtrClInt32T(pPyld, count, msg, isDelete)
 Marshall pointer of ClInt32T type.
#define clXdrMarshallPtrClInt64T(pPyld, count, msg, isDelete)
 Marshall pointer of ClInt64T type.
#define clXdrMarshallPtrClNameT(pointer, multiplicity, msg, isDelete)
 Marshall pointer of ClNameT type.
#define clXdrMarshallPtrClUint32T(pPyld, count, msg, isDelete)
 Marshall pointer of ClUint32T type.
#define clXdrMarshallPtrClUint64T(pPyld, count, msg, isDelete)
 Marshall pointer of ClUint64T type.
#define clXdrMarshallPtrClVersionT(pointer, multiplicity, msg, isDelete)
 Marshall pointer of ClVersionT type.
#define clXdrMarshallPtrClWordT(pointer, multiplicity, msg, isDelete)
 Marshall pointer of ClWordT type.
#define clXdrUnmarshallArrayClInt32T(msg, pPyld, count)
 Unmarshall data of ClInt32T array type.
#define clXdrUnmarshallArrayClInt64T(msg, pPyld, count)
 Unmarshall data of ClInt64T array type.
#define clXdrUnmarshallArrayClNameT(msg, pointer, multiplicity)
 Unmarshall data of ClNameT array type.
#define clXdrUnmarshallArrayClUint32T(msg, pPyld, count)
 Unmarshall data of ClUint32T array type.
#define clXdrUnmarshallArrayClUint64T(msg, pPyld, count)
 Unmarshall data of ClUint64T array type.
#define clXdrUnmarshallPtrClHandleT(msg, pointer, multiplicity)
 Unmarshall data of ClHandleT pointer type.
#define clXdrUnmarshallPtrClInt32T(msg, pPyld, multiplicity)
 Unmarshall data of ClInt32T pointer type.
#define clXdrUnmarshallPtrClInt64T(msg, pPyld, multiplicity)
 Unmarshall data of ClInt64T pointer type.
#define clXdrUnmarshallPtrClNameT(msg, pointer, multiplicity)
 Unmarshall data of ClNameT pointer type.
#define clXdrUnmarshallPtrClUint32T(msg, pPyld, multiplicity)
 Unmarshall data of ClUint32T pointer type.
#define clXdrUnmarshallPtrClUint64T(msg, pPyld, multiplicity)
 Unmarshall data of ClUint64T pointer type.
#define clXdrUnmarshallPtrClVersionT(msg, pointer, multiplicity)
 Unmarshall data of ClVersionT pointer type.
#define clXdrUnmarshallPtrClWordT(msg, pointer, multiplicity)
 Unmarshall data of ClWordT pointer type.

Functions

ClRcT clXdrMarshallArrayClCharT (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall array of ClCharT type.
ClRcT clXdrMarshallArrayClInt16T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall array of ClInt16T type.
ClRcT clXdrMarshallArrayClInt8T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall array of ClInt8T type.
ClRcT clXdrMarshallArrayClUint16T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall array of ClUint16T type.
ClRcT clXdrMarshallArrayClUint8T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall array of ClUint8T type.
ClRcT clXdrMarshallClCharT (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClCharT type.
ClRcT clXdrMarshallClHandleT (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClHandleT type.
ClRcT clXdrMarshallClInt16T (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClInt16T type.
ClRcT clXdrMarshallClInt32T (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClInt32T type.
ClRcT clXdrMarshallClInt64T (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClInt64T type.
ClRcT clXdrMarshallClInt8T (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClInt8T type.
ClRcT clXdrMarshallClNameT (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClNameT type.
ClRcT clXdrMarshallClUint16T (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClUint16T type.
ClRcT clXdrMarshallClUint32T (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClUint32T type.
ClRcT clXdrMarshallClUint64T (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClUint64T type.
ClRcT clXdrMarshallClUint8T (CL_IN void *pPyld, CL_INOUT ClBufferHandleT msg, CL_IN ClUint32T isDelete)
 Marshall data of ClUint8T type.
ClRcT clXdrMarshallClVersionT (void *pGenVar, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClVersionT type.
ClRcT clXdrMarshallClWordT (void *pPyld, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall data of ClWordT type.
ClRcT clXdrMarshallPtrClCharT (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall pointer of ClCharT type.
ClRcT clXdrMarshallPtrClInt16T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall pointer of ClInt16T type.
ClRcT clXdrMarshallPtrClInt8T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall pointer of ClInt8T type.
ClRcT clXdrMarshallPtrClUint16T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall pointer of ClUint16T type.
ClRcT clXdrMarshallPtrClUint8T (void *pPyld, ClUint32T count, ClBufferHandleT msg, ClUint32T isDelete)
 Marshall pointer of ClUint8T type.
ClRcT clXdrUnmarshallArrayClCharT (ClBufferHandleT msg, void *pPyld, ClUint32T count)
 Unmarshall data of ClCharT array type.
ClRcT clXdrUnmarshallArrayClInt16T (ClBufferHandleT msg, void *pPyld, ClUint32T count)
 Unmarshall data of ClInt16T array type.
ClRcT clXdrUnmarshallArrayClInt8T (ClBufferHandleT msg, void *pPyld, ClUint32T count)
 Unmarshall data of ClInt8T array type.
ClRcT clXdrUnmarshallArrayClUint16T (ClBufferHandleT msg, void *pPyld, ClUint32T count)
 Unmarshall data of ClUint16T array type.
ClRcT clXdrUnmarshallArrayClUint8T (ClBufferHandleT msg, void *pPyld, ClUint32T count)
 Unmarshall data of ClUint8T array type.
ClRcT clXdrUnmarshallClCharT (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClCharT type.
ClRcT clXdrUnmarshallClHandleT (ClBufferHandleT msg, void *pBuf)
 Unmarshall data of ClHandleT type.
ClRcT clXdrUnmarshallClInt16T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClInt16T type.
ClRcT clXdrUnmarshallClInt32T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClInt32T type.
ClRcT clXdrUnmarshallClInt64T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClInt64T type.
ClRcT clXdrUnmarshallClInt8T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClInt8T type.
ClRcT clXdrUnmarshallClNameT (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClNameT type.
ClRcT clXdrUnmarshallClUint16T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClUint16T type.
ClRcT clXdrUnmarshallClUint32T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClUint32T type.
ClRcT clXdrUnmarshallClUint64T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClUint64T type.
ClRcT clXdrUnmarshallClUint8T (ClBufferHandleT msg, void *pPyld)
 Unmarshall data of ClUint8T type.
ClRcT clXdrUnmarshallClVersionT (ClBufferHandleT msg, void *pGenVar)
 Unmarshall data of ClVersionT type.
ClRcT clXdrUnmarshallClWordT (ClBufferHandleT msg, void *pBuf)
 Unmarshall data of ClWordT type.
ClRcT clXdrUnmarshallPtrClCharT (ClBufferHandleT msg, void **pPyld, ClUint32T multiplicity)
 Unmarshall data of ClCharT pointer type.
ClRcT clXdrUnmarshallPtrClInt16T (ClBufferHandleT msg, void **pPyld, ClUint32T multiplicity)
 Unmarshall data of ClInt16T pointer type.
ClRcT clXdrUnmarshallPtrClInt8T (ClBufferHandleT msg, void **pPyld, ClUint32T multiplicity)
 Unmarshall data of ClInt8T pointer type.
ClRcT clXdrUnmarshallPtrClUint16T (ClBufferHandleT msg, void **pPyld, ClUint32T multiplicity)
 Unmarshall data of ClUint16T pointer type.
ClRcT clXdrUnmarshallPtrClUint8T (ClBufferHandleT msg, void **pPyld, ClUint32T multiplicity)
 Unmarshall data of ClUint8T pointer type.

Detailed Description

Defines, Structures, Typedefs, Functions.

Macro Definition Documentation

#define clXdrMarshallArrayClInt32T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallArray((pPyld), sizeof(ClInt32T), \
(msg),(isDelete))

Marshall array of ClInt32T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClInt32T, which is to be marshalled.
count(in) This is the number of elements of type ClInt32T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt32T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClInt32T()
#define clXdrMarshallArrayClInt64T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallArray((pPyld), sizeof(ClInt64T), \
(msg), (isDelete))

Marshall array of ClInt64T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClInt64T, which is to be marshalled.
count(in) This is the number of elements of type ClInt64T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt64T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClInt64T()
#define clXdrMarshallArrayClNameT (   pointer,
  multiplicity,
  msg,
  isDelete 
)
Value:
clXdrMarshallArray((pointer), sizeof(ClNameT), \
(multiplicity), clXdrMarshallClNameT, \
(msg), (isDelete))

Marshall array of ClNameT type.

Header File:
clXdrApi.h
Parameters
pointer(in) This parameter is the array of type ClNameT, which is to be marshalled.
multiplicity(in) This is the number of elements of type ClNameT to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClNameT array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClNameT()
#define clXdrMarshallArrayClUint32T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallArray((pPyld), sizeof(ClUint32T), \
(msg), (isDelete))

Marshall array of ClUint32T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClUint32T, which is to be marshalled.
count(in) This is the number of elements of type ClUint32T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint32T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClUint32T()
#define clXdrMarshallArrayClUint64T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallArray((pPyld), sizeof(ClUint64T), \
(msg), (isDelete))

Marshall array of ClUint64T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClUint64T, which is to be marshalled.
count(in) This is the number of elements of type ClUint64T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint64T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClUint64T()
#define clXdrMarshallPtrClHandleT (   pointer,
  multiplicity,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pointer), sizeof(ClHandleT), \
(multiplicity), clXdrMarshallClHandleT, \
(msg), (isDelete))

Marshall pointer of ClHandleT type.

Header File:
clXdrApi.h
Parameters
pointer(in) This parameter is the pointer to the payload data of type ClHandleT, which is to be marshalled.
multiplicity(in) This is the number of elements of type ClHandleT to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClHandleT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClHandleT()
#define clXdrMarshallPtrClInt32T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pPyld), sizeof(ClInt32T), \
(msg), (isDelete))

Marshall pointer of ClInt32T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClInt32T, which is to be marshalled.
count(in) This is the number of elements of type ClInt32T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt32T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClInt32T()
#define clXdrMarshallPtrClInt64T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pPyld), sizeof(ClInt64T), \
(msg), (isDelete))

Marshall pointer of ClInt64T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClInt64T, which is to be marshalled.
count(in) This is the number of elements of type ClInt64T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt64T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClInt64T()
#define clXdrMarshallPtrClNameT (   pointer,
  multiplicity,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pointer), sizeof(ClNameT), \
(multiplicity), clXdrMarshallClNameT, \
(msg), (isDelete))

Marshall pointer of ClNameT type.

Header File:
clXdrApi.h
Parameters
pointer(in) This parameter is the pointer to the payload data of type ClNameT, which is to be marshalled.
multiplicity(in) This is the number of elements of type ClNameT to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClNameT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClNameT()
#define clXdrMarshallPtrClUint32T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pPyld), sizeof(ClUint32T), \
(msg), (isDelete))

Marshall pointer of ClUint32T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClUint32T, which is to be marshalled.
count(in) This is the number of elements of type ClUint32T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint32T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClUint32T()
#define clXdrMarshallPtrClUint64T (   pPyld,
  count,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pPyld), sizeof(ClUint64T), \
(msg), (isDelete))

Marshall pointer of ClUint64T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClUint64T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
count(in) This is the number of elements of type ClUint64T to be marshalled and pointed by the payload data.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint64T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClUint64T()
#define clXdrMarshallPtrClVersionT (   pointer,
  multiplicity,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pointer), sizeof(ClVersionT), \
(multiplicity), clXdrMarshallClVersionT, \
(msg), (isDelete))

Marshall pointer of ClVersionT type.

Header File:
clXdrApi.h
Parameters
pointer(in) This parameter is the pointer to the payload data of type ClVersionT, which is to be marshalled.
multiplicity(in) This is the number of elements of type ClVersionT to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClVersionT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClVersionT()
#define clXdrMarshallPtrClWordT (   pointer,
  multiplicity,
  msg,
  isDelete 
)
Value:
clXdrMarshallPtr((pointer), sizeof(ClWordT), \
(multiplicity), clXdrMarshallClWordT, \
(msg), (isDelete))

Marshall pointer of ClWordT type.

Header File:
clXdrApi.h
Parameters
pointer(in) This parameter is the pointer to the payload data of type ClWordT, which is to be marshalled.
multiplicity(in) This is the number of elements of type ClWordT to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClWordT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClWordT()
#define clXdrUnmarshallArrayClInt32T (   msg,
  pPyld,
  count 
)
Value:
clXdrUnmarshallArray((msg), \
(pPyld), sizeof(ClInt32T), \

Unmarshall data of ClInt32T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClInt32T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClInt32T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt32T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClInt32T()
#define clXdrUnmarshallArrayClInt64T (   msg,
  pPyld,
  count 
)
Value:
clXdrUnmarshallArray((msg), \
(pPyld), sizeof(ClInt64T), \

Unmarshall data of ClInt64T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClInt64T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClInt64T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt64T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClInt64T()
#define clXdrUnmarshallArrayClNameT (   msg,
  pointer,
  multiplicity 
)
Value:
clXdrUnmarshallArray((msg), \
(pointer), sizeof(ClNameT), \
(multiplicity), clXdrUnmarshallClNameT)

Unmarshall data of ClNameT array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pointer(out) This parameter is pointer to the payload data of ClNameT array type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClNameT in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClNameT array type. The successful execution of this function unmarshalles the marshalled data into 'pointer' parameter.
Library File:
ClUtil
See Also
clXdrMarshallArrayClNameT()
#define clXdrUnmarshallArrayClUint32T (   msg,
  pPyld,
  count 
)
Value:
clXdrUnmarshallArray((msg), \
(pPyld), sizeof(ClUint32T), \

Unmarshall data of ClUint32T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClUint32T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClUint32T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint32T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClUint32T()
#define clXdrUnmarshallArrayClUint64T (   msg,
  pPyld,
  count 
)
Value:
clXdrUnmarshallArray((msg), \
(pPyld), sizeof(ClUint64T), \

Unmarshall data of ClUint64T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClUint64T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClUint64T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint64T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClUint64T()
#define clXdrUnmarshallPtrClHandleT (   msg,
  pointer,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pointer), sizeof(ClHandleT), \
multiplicity, clXdrUnmarshallClHandleT)

Unmarshall data of ClHandleT pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pointer(out) This parameter is the pointer of ClHandleT type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClHandleT to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClHandleT pointer type. The successful execution of this function unmarshalles the marshalled data into 'pointer' parameter.
Library File:
ClUtil
See Also
clXdrMarshallPtrClHandleT()
#define clXdrUnmarshallPtrClInt32T (   msg,
  pPyld,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pPyld), sizeof(ClInt32T), \
multiplicity, clXdrUnmarshallClInt32T)

Unmarshall data of ClInt32T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClInt32T pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClInt32T to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt32T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClInt32T()
#define clXdrUnmarshallPtrClInt64T (   msg,
  pPyld,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pPyld), sizeof(ClInt64T), \
multiplicity, clXdrUnmarshallClInt64T)

Unmarshall data of ClInt64T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClInt64T pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClInt64T to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt64T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClInt64T()
#define clXdrUnmarshallPtrClNameT (   msg,
  pointer,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pointer), sizeof(ClNameT), \
multiplicity, clXdrUnmarshallClNameT)

Unmarshall data of ClNameT pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pointer(out) This parameter is of ClNameT pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClNameT to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClNameT pointer type. The successful execution of this function unmarshalles the marshalled data into 'pointer' parameter.
Library File:
ClUtil
See Also
clXdrMarshallPtrClNameT()
#define clXdrUnmarshallPtrClUint32T (   msg,
  pPyld,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pPyld), sizeof(ClUint32T), \
multiplicity, clXdrUnmarshallClUint32T)

Unmarshall data of ClUint32T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is of ClUint32T pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClUint32T to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint32T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClUint32T()
#define clXdrUnmarshallPtrClUint64T (   msg,
  pPyld,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pPyld), sizeof(ClUint64T), \

Unmarshall data of ClUint64T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is of ClUint64T pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClUint64T to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint64T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClUint64T()
#define clXdrUnmarshallPtrClVersionT (   msg,
  pointer,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pointer), sizeof(ClVersionT), \

Unmarshall data of ClVersionT pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pointer(out) This parameter is of ClVersionT pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClVersionT to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClVersionT pointer type. The successful execution of this function unmarshalles the marshalled data into 'pointer' parameter.
Library File:
ClUtil
See Also
clXdrMarshallPtrClVersionT()
#define clXdrUnmarshallPtrClWordT (   msg,
  pointer,
  multiplicity 
)
Value:
clXdrUnmarshallPtr((msg), \
(pointer), sizeof(ClWordT), \
multiplicity, clXdrUnmarshallClWordT)

Unmarshall data of ClWordT pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pointer(out) This parameter is the pointer of ClWordT type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClWordT to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClWordT pointer type. The successful execution of this function unmarshalles the marshalled data into 'pointer' parameter.
Library File:
ClUtil
See Also
clXdrMarshallPtrClWordT()

Function Documentation

ClRcT clXdrMarshallArrayClCharT ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall array of ClCharT type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClCharT, which is to be marshalled.
count(in) This is the number of elements of type ClCharT to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClCharT array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClCharT()
ClRcT clXdrMarshallArrayClInt16T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall array of ClInt16T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClInt16T, which is to be marshalled.
count(in) This is the number of elements of type ClInt16T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt16T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClInt16T()
ClRcT clXdrMarshallArrayClInt8T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall array of ClInt8T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClInt8T, which is to be marshalled.
count(in) This is the number of elements of type ClInt8T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt8T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClInt8T()
ClRcT clXdrMarshallArrayClUint16T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall array of ClUint16T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClUint16T, which is to be marshalled.
count(in) This is the number of elements of type ClUint16T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint16T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClUint16T()
ClRcT clXdrMarshallArrayClUint8T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall array of ClUint8T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the array of type ClUint8T, which is to be marshalled.
count(in) This is the number of elements of type ClUint8T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint8T array type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallArrayClUint8T()
ClRcT clXdrMarshallClCharT ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClCharT type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClCharT, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClCharT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClCharT
ClRcT clXdrMarshallClHandleT ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClHandleT type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClHandleT, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClHandleT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClHandleT
ClRcT clXdrMarshallClInt16T ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClInt16T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClInt16T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt16T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClInt16T
ClRcT clXdrMarshallClInt32T ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClInt32T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClInt32T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt32T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClInt32T
ClRcT clXdrMarshallClInt64T ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClInt64T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClInt64T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt64T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClInt64T
ClRcT clXdrMarshallClInt8T ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClInt8T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClInt8T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt8T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClInt8T
ClRcT clXdrMarshallClNameT ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClNameT type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClNameT, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClNameT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClNameT
ClRcT clXdrMarshallClUint16T ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClUint16T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClUint16T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint16T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClUint16T()
ClRcT clXdrMarshallClUint32T ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClUint32T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClUint32T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint32T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClUint32T()
ClRcT clXdrMarshallClUint64T ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClUint64T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClUint64T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint64T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClUint64T()
ClRcT clXdrMarshallClUint8T ( CL_IN void *  pPyld,
CL_INOUT ClBufferHandleT  msg,
CL_IN ClUint32T  isDelete 
)

Marshall data of ClUint8T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClUint8T, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint8T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClUint8T
ClRcT clXdrMarshallClVersionT ( void *  pGenVar,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClVersionT type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClVersionT, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClVersionT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClVersionT()
ClRcT clXdrMarshallClWordT ( void *  pPyld,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall data of ClWordT type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the reference to the payload data of type ClWordT, which is to be marshalled.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, but in this function it should always be specified as 0 - Don't delete.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClWordT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallClWordT
ClRcT clXdrMarshallPtrClCharT ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall pointer of ClCharT type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClCharT, which is to be marshalled.
count(in) This is the number of elements of type ClCharT to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClCharT type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClCharT()
ClRcT clXdrMarshallPtrClInt16T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall pointer of ClInt16T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClInt16T, which is to be marshalled.
count(in) This is the number of elements of type ClInt16T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt16T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClInt16T()
ClRcT clXdrMarshallPtrClInt8T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall pointer of ClInt8T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClInt8T, which is to be marshalled.
count(in) This is the number of elements of type ClInt8T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClInt8T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClInt8T()
ClRcT clXdrMarshallPtrClUint16T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall pointer of ClUint16T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClUint16T, which is to be marshalled.
count(in) This is the number of elements of type ClUint16T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint16T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClUint16T()
ClRcT clXdrMarshallPtrClUint8T ( void *  pPyld,
ClUint32T  count,
ClBufferHandleT  msg,
ClUint32T  isDelete 
)

Marshall pointer of ClUint8T type.

Header File:
clXdrApi.h
Parameters
pPyld(in) This parameter is the pointer to the payload data of type ClUint8T, which is to be marshalled.
count(in) This is the number of elements of type ClUint8T to be marshalled and pointed by the payload data.
msg(inout) This is the handle to the buffer which is created by the user. On success this message handle is updated and it contains this marshalled data along with any other data which was marshalled using this handle earlier. This handle should be used as in-message-handle for making the rmd call.
isDelete(in) This parameter is used in deleting the payload data, and it takes one of the following two values: 0 - Don't Delete or 1 - Delete the payload data after marshalling.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
Description:
This function is used to marshall the payload data of ClUint8T type. The successful execution of this function adds the marshalled data into message handle which should be used to transfer the data over network using rmd call.
Library File:
ClUtil
See Also
clXdrUnmarshallPtrClUint8T()
ClRcT clXdrUnmarshallArrayClCharT ( ClBufferHandleT  msg,
void *  pPyld,
ClUint32T  count 
)

Unmarshall data of ClCharT array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClCharT array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClCharT in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClCharT array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClCharT()
ClRcT clXdrUnmarshallArrayClInt16T ( ClBufferHandleT  msg,
void *  pPyld,
ClUint32T  count 
)

Unmarshall data of ClInt16T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClInt16T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClInt16T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt16T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClInt16T()
ClRcT clXdrUnmarshallArrayClInt8T ( ClBufferHandleT  msg,
void *  pPyld,
ClUint32T  count 
)

Unmarshall data of ClInt8T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClInt8T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClInt8T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt8T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClInt8T()
ClRcT clXdrUnmarshallArrayClUint16T ( ClBufferHandleT  msg,
void *  pPyld,
ClUint32T  count 
)

Unmarshall data of ClUint16T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClUint16T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClUint16T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint16T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClUint16T()
ClRcT clXdrUnmarshallArrayClUint8T ( ClBufferHandleT  msg,
void *  pPyld,
ClUint32T  count 
)

Unmarshall data of ClUint8T array type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClUint8T array type and the unmarshalled data is filled into this.
count(in) This is the number of elements of type ClUint8T in the array to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint8T array type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallArrayClUint8T()
ClRcT clXdrUnmarshallClCharT ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClCharT type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClCharT and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClCharT type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClCharT
ClRcT clXdrUnmarshallClHandleT ( ClBufferHandleT  msg,
void *  pBuf 
)

Unmarshall data of ClHandleT type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pBuf(out) This parameter is the pointer of type void* and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClHandleT type. The successful execution of this function unmarshalles the marshalled data into 'pBuf' parameter.
Library File:
ClUtil
See Also
clXdrMarshallClHandleT()
ClRcT clXdrUnmarshallClInt16T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClInt16T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClInt16T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt16T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClInt16T()
ClRcT clXdrUnmarshallClInt32T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClInt32T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClInt32T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt32T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClInt32T()
ClRcT clXdrUnmarshallClInt64T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClInt64T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClInt64T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt64T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClInt64T()
ClRcT clXdrUnmarshallClInt8T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClInt8T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClInt8T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt8T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClInt8T()
ClRcT clXdrUnmarshallClNameT ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClNameT type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the pointer of type void* and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClNameT type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClNameT()
ClRcT clXdrUnmarshallClUint16T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClUint16T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClUint16T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint16T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClUint16T
ClRcT clXdrUnmarshallClUint32T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClUint32T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClUint32T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint32T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClUint32T()
ClRcT clXdrUnmarshallClUint64T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClUint64T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClUint64T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint64T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClUint64T()
ClRcT clXdrUnmarshallClUint8T ( ClBufferHandleT  msg,
void *  pPyld 
)

Unmarshall data of ClUint8T type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the reference to the payload data of type ClUint8T and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint8T type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallClUint8T()
ClRcT clXdrUnmarshallClVersionT ( ClBufferHandleT  msg,
void *  pGenVar 
)

Unmarshall data of ClVersionT type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pGenVar(out) This parameter is of type void* the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClVersionT type. The successful execution of this function unmarshalles the marshalled data into 'pGenVar' parameter.
Library File:
ClUtil
See Also
clXdrMarshallClVersionT()
ClRcT clXdrUnmarshallClWordT ( ClBufferHandleT  msg,
void *  pBuf 
)

Unmarshall data of ClWordT type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pBuf(out) This parameter is the pointer of type void* and the unmarshalled data is filled into this.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClWordT type. The successful execution of this function unmarshalles the marshalled data into 'pBuf' parameter.
Library File:
ClUtil
See Also
clXdrMarshallClWordT()
ClRcT clXdrUnmarshallPtrClCharT ( ClBufferHandleT  msg,
void **  pPyld,
ClUint32T  multiplicity 
)

Unmarshall data of ClCharT pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is of type void** and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClCharT* to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClCharT pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClCharT()
ClRcT clXdrUnmarshallPtrClInt16T ( ClBufferHandleT  msg,
void **  pPyld,
ClUint32T  multiplicity 
)

Unmarshall data of ClInt16T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is of void** type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClInt16T* to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt16T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClInt16T()
ClRcT clXdrUnmarshallPtrClInt8T ( ClBufferHandleT  msg,
void **  pPyld,
ClUint32T  multiplicity 
)

Unmarshall data of ClInt8T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is of void** type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClInt8T* to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClInt8T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClInt8T()
ClRcT clXdrUnmarshallPtrClUint16T ( ClBufferHandleT  msg,
void **  pPyld,
ClUint32T  multiplicity 
)

Unmarshall data of ClUint16T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClUint16T pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClUint16T* to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint16T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClUint16T()
ClRcT clXdrUnmarshallPtrClUint8T ( ClBufferHandleT  msg,
void **  pPyld,
ClUint32T  multiplicity 
)

Unmarshall data of ClUint8T pointer type.

Header File:
clXdrApi.h
Parameters
msg(in) This handle is actually received in RMD receive function as in-message-handle. On success this message handle is updated and it contains the remaining data which were marshalled using this handle and still not unmarshalled.
pPyld(out) This parameter is the payload data of ClUint8T pointer type and the unmarshalled data is filled into this.
multiplicity(in) This is the number of elements of type ClUint8T* to be unmarshalled.
Return values
CL_OKThe function executed successfully.
CL_ERR_NULL_POINTEROn passing any of the pointer parameter as NULL.
CL_ERR_INVALID_PARAMETEROn passing msg handle as 0(invalid).
Description:
This function is used to unmarshall the payload data of ClUint8T pointer type. The successful execution of this function unmarshalles the marshalled data into pPyld i.e. pPyld contains the data.
Library File:
ClUtil
See Also
clXdrMarshallPtrClUint8T()

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen