---
name: "xs_msg_init"
section: "3"
platform: "linux"
package: "libxs-dev"
version: "1.2.0-2"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/xs_msg_init"
---

# xs\_msg\_init(3)

initialise empty Crossroads message

## NAME

xs\_msg\_init - initialise empty Crossroads message

## SYNOPSIS

**int xs\_msg\_init (xs\_msg\_t** *\*msg***);**

## DESCRIPTION

The *xs\_msg\_init()* function shall initialise the message object referenced by *msg* to represent an empty message. This function is most useful when called before receiving a message with *xs\_recv()*.

**Caution**\

Never access *xs\_msg\_t* members directly, instead always use the *xs\_msg* family of functions.

**Caution**\

The functions *xs\_msg\_init()*, *xs\_msg\_init\_data()* and *xs\_msg\_init\_size()* are mutually exclusive. Never initialize the same *xs\_msg\_t* twice.

## RETURN VALUE

The *xs\_msg\_init()* function shall return zero if successful. Otherwise it shall return -1 and set *errno* to one of the values defined below.

## ERRORS

No errors are defined.

## EXAMPLE

**Receiving a message from a socket**.

```
xs_msg_t msg;
rc = xs_msg_init (&msg);
assert (rc == 0);
rc = xs_recv (socket, &msg, 0);
assert (rc == 0);
```

## SEE ALSO

[**xs\_msg\_init\_size**(3)](/xs_msg_init_size/3.md) [**xs\_msg\_init\_data**(3)](/xs_msg_init_data/3.md) [**xs\_msg\_close**(3)](/xs_msg_close/3.md) [**xs\_msg\_data**(3)](/xs_msg_data/3.md) [**xs\_msg\_size**(3)](/xs_msg_size/3.md) [**xs**(7)](/xs/7.md)

## AUTHORS

The Crossroads documentation was written by Martin Sustrik \<**sustrik@250bpm.com**\[1\]\> and Martin Lucina \<**martin@lucina.net**\[2\]\>.

## NOTES

- 1\.

  sustrik@250bpm.com

  mailto:sustrik@250bpm.com

- 2\.

  martin@lucina.net

  mailto:martin@lucina.net