boost::urls::string_token::arg::prepare :: Boost Libraries Documentation

# boost::urls::string_token::arg::prepare

Return a modifiable character buffer

## Synopsis

Declared in `<boost/url/grammar/string_token.hpp>`

    virtual
    char*
    prepare(std::size_t n) = 0;

## Description

This function attempts to obtain a character buffer with space for at least `n` characters. Upon success, a pointer to the beginning of the buffer is returned. Ownership is not transferred; the caller should not attempt to free the storage. The buffer shall remain valid until `this` is destroyed.

| This function may only be called once. After invoking the function, the only valid operation is destruction.

## Return Value

A pointer to the buffer

## Parameters

Name | Description
--- | ---
n | The number of characters needed

Created with MrDocs