/**
 *  @file account.h
 *  @copyright defined in eos/LICENSE.txt
 */
#pragma once

#include <eosiolib/types.h>

/**
 *  @defgroup accountapi Account API
 *  @brief Define API for querying account data
 *  @ingroup contractdev
 */

/**
 *  @defgroup accountcapi Account C API
 *  @brief C API for querying account data
 *  @ingroup accountapi
 *  @{
 */

extern "C" {
   /**
    * @brief Retrieve the balance for the provided account
    * @details Retrieve the balance for the provided account
    *
    * @param balance -  a pointer to a range of memory to store balance data
    * @param len     -  length of the range of memory to store balance data
    * @return true if account information is retrieved
    *
    * @pre data is a valid pointer to a range of memory at least datalen bytes long
    * @pre data is a pointer to a balance object
    * @pre *((uint64_t*)data) stores the primary key
    *
    *  Example:
    *  @code
    *  balance b;
    *  b.account = N(myaccount);
    *  balance(b, sizeof(balance));
    *  @endcode
    *
    */

   bool account_balance_get( void* balance, uint32_t len );
   ///@ } accountcapi
}