billmax documentation   BillMax Billing Solutions
  877.245.5629
  sales@billmax.com
 

Name

BillMax_TierplanDescribe — Create a description of usage

Synopsis

#include "billmax.h"
const char *BillMax_TierplanDescribe( tierplan,  
  tierplan,  
  tiervalue);  
  tierplan;
  tiervalue;

DESCRIPTION

Creates a description of usage. Given tierplan and tiervalue(a Usage Based Computation Result). Returns a string describing the Usage Based Computation Result. This may be used in sending emails or included in statements.

PARAMETERS

TIERPLAN *

The Tierplan to describe. See TIERPLAN structure.

double tiervalue

The Usage Based Computation Result.

RETURN VALUE

Example 1.1. BillMax_TierplanDescribe result for the Average Method

Average: 28.2 MB/sec


Example 1.2. BillMax_TierplanDescribe result for an Unknown Method

tierplan n: bad method m

where m is tierplan->number and m is tierplan->method.


NOTES

Uses BillMax_RegisterStorage

SEE ALSO

NONE


Document Revision A for BillMax 2.2.0   -   Copyright © 1997-2006 The iSpark Group, Inc.

All rights reserved. No part of this documentation may be reproduced or transmitted in any fashion without written permission by The iSpark Group, Inc. This documentation is for the sole use of licensees of the BillMax billing software created by The iSpark Group, Inc. Making the documentation available to a non-licensee of BillMax without written permission of The iSpark Group, Inc. is a violation of the use of this documentation.

While precautions have been taken in the preparation of this documentation, The iSpark Group, Inc. assumes neither liability nor responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

All terms mentioned that are known to be trademarks have been appropriately capitalized. Use of the a trademark does not affect the validity of any trademark or service mark.

Links to third-party Web sites are provided for convenience. The iSpark Group, Inc. is not responsible for any content contained in the third-party Web sites.

Comments about this documentation may be sent to doc@billmax.com