# CassCustomPayload

### struct CassCustomPayload

### Public Functions

### [CassCustomPayload](#_CPPv417CassCustomPayload) \*cass_custom_payload_new()

Creates a new custom payload.

**Warning:** This function is not yet implemented.

#### SEE ALSO
[cass_custom_payload_free()](#struct_cass_custom_payload_1a211032ad4c108f1623e81d517d3bc008)

* **Returns:**
  Returns a custom payload that must be freed.

### void cass_custom_payload_free([CassCustomPayload](#_CPPv417CassCustomPayload) \*payload)

Frees a custom payload instance.

**Warning:** This function is not yet implemented.

* **Parameters:**
  **payload** – **[in]** 

### void cass_custom_payload_set([CassCustomPayload](#_CPPv417CassCustomPayload) \*payload, const char \*name, const [cass_byte_t](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/group.BasicTypes.md#_CPPv411cass_byte_t) \*value, size_t value_size)

Sets an item to the custom payload.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **payload** – **[in]** 
  * **name** – **[in]** 
  * **value** – **[in]** 
  * **value_size** – **[in]** 

### void cass_custom_payload_set_n([CassCustomPayload](#_CPPv417CassCustomPayload) \*payload, const char \*name, size_t name_length, const [cass_byte_t](https://cpp-rs-driver.docs.scylladb.com/v1.1.0/api/group.BasicTypes.md#_CPPv411cass_byte_t) \*value, size_t value_size)

Same as [cass_custom_payload_set()](#struct_cass_custom_payload_1a68dfc003daa0c24ec0559e2bf9e3d8b2), but with lengths for string parameters.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **payload** – **[in]** 
  * **name** – **[in]** 
  * **name_length** – **[in]** 
  * **value** – **[in]** 
  * **value_size** – **[in]** 

### void cass_custom_payload_remove([CassCustomPayload](#_CPPv417CassCustomPayload) \*payload, const char \*name)

Removes an item from the custom payload.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **payload** – **[in]** 
  * **name** – **[in]** 

### void cass_custom_payload_remove_n([CassCustomPayload](#_CPPv417CassCustomPayload) \*payload, const char \*name, size_t name_length)

Same as [cass_custom_payload_set()](#struct_cass_custom_payload_1a68dfc003daa0c24ec0559e2bf9e3d8b2), but with lengths for string parameters.

**Warning:** This function is not yet implemented.

* **Parameters:**
  * **payload** – **[in]** 
  * **name** – **[in]** 
  * **name_length** – **[in]**