---
name: "xs_msg_init_size"
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_size"
---

# xs\_msg\_init\_size(3)

initialise Crossroads message of a specified size

## NAME

xs\_msg\_init\_size - initialise Crossroads message of a specified size

## SYNOPSIS

**int xs\_msg\_init\_size (xs\_msg\_t** *\*msg***, size\_t** *size***);**

## DESCRIPTION

The *xs\_msg\_init\_size()* function shall allocate any resources required to store a message *size* bytes long and initialise the message object referenced by *msg* to represent the newly allocated message.

The implementation shall choose whether to store message content on the stack (small messages) or on the heap (large messages). For performance reasons *xs\_msg\_init\_size()* shall not clear the message data.

**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\_size()* function shall return zero if successful. Otherwise it shall return -1 and set *errno* to one of the values defined below.

## ERRORS

**ENOMEM**

Insufficient storage space is available.

## SEE ALSO

[**xs\_msg\_init\_data**(3)](/xs_msg_init_data/3.md) [**xs\_msg\_init**(3)](/xs_msg_init/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