ipcGetData(2K)

NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO

NAME

ipcGetData- get the current message body

SYNOPSIS

#include <ipc/chIpc.h>

int ipcGetData(KnMsgDesc *msg);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

FEATURES

IPC

DESCRIPTION

The ipcGetData call copies the body of the current thread's current message to the thread's address space.

The message body is received only if the message was received with a NULL bodyAddr argument (see ipcReceive(2K)). The message body may only be obtained once; system buffers are freed after the operation.

The msg field points to a KnMsgDesc structure, as described in ipcReceive(2K).

RETURN VALUE

This function returns the number of bytes that have been copied.

ERRORS

[K_EINVAL]

There is no current message (no message has been received by the current thread since the last ipcReply(2K) or ipcSave(2K)).

[K_EFAULT]

Some of the data provided are outside the current actor's address space.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

ipcReceive(2K)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | FEATURES | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | SEE ALSO