| Home | Libraries | People | FAQ | More

## Class xsi_key

boost::interprocess::xsi_key

## Synopsis

    // In header: <boost/interprocess/xsi_key.hpp>

    class xsi_key {
    public:
      // construct/copy/destruct
      xsi_key();
      explicit xsi_key(key_t);
      xsi_key(const char *, boost::uint8_t);

      // public member functions
      key_t get_key() const;
    };

## Description

A class that wraps XSI (System V) key_t type. This type calculates key_t from path and id using ftok, sets key to a specified value, or sets key to IPC_PRIVATE using the default constructor.

### `xsi_key` public construct/copy/destruct

1.     xsi_key();

   Default constructor. Represents a private `xsi_key`.

2.     explicit xsi_key(key_t key);

   Creates a new XSI key using a specified value. Constructor is explicit to avoid ambiguity with shmid.

3.     xsi_key(const char * path, boost::uint8_t id);

   Creates a new XSI shared memory with a key obtained from a call to ftok (with path "path" and id "id"), of size "size" and permissions "perm". If the shared memory previously exists, throws an error.

### `xsi_key` public member functions

1.     key_t get_key() const;

   Returns the internal key_t value.