COPYRIGHT

Copyright (c) 2005 Dave Oberholtzer (daveo@obernet.com). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

REDIRECT

This page is probably out of date. Please refer to the FameHLI::API or README file for more accurate info. This discrepency will be handled in a later release because I really do want accurate documentation.

NAME

FameHLI::API::EXT - Perl extension for Fame C-HLI functions

SYNOPSIS

  use FameHLI::API;
  use FameHLI::API::HLI ':all';
  use FameHLI::API::EXT;
  my $rc = FameHLI::API::Cfmxxx(arg_list);
  printf("Cfmini said '%s'\n", FameHLI::API::EXT::ErrDesc($rc));

Where Cfmxxx is a FameHLI::API function.

FUNCTIONS

  $str = FormatDate($date, $freq, $image, $fmonth, $flabel);
  $str = ClassDesc($class);
  $str = ErrDesc($rc);
  $str = FreqDesc($freq);
  $str = TypeDesc($type);
  $str = AccessModeDesc($mode);
  $str = BasisDesc($basis);
  $str = ObservedDesc($observ);
  $str = MonthsDesc($month);
  $str = OldFYEndDesc($fy);
  $str = WeekdayDesc($date);
  $str = BiWeekdayDesc($date);
  $str = FYLabelDesc($label);

DESCRIPTION

The FameHLI::API::EXT functions are 'helper' functions, most of which return the textual description of a FameHLI::API::HLI constant.

The functions are basically self explanitory as they each, with the exception of FormatDate, return descriptive text about the code passed in. If you want to know the textual description of a FREQUENCY you call FreqDesc() and so on.

RETURN VALUE

Functions all return strings. It is assumed that you will pass in a valid value. If not, you will get the string "Undefined" or something equally rude.

ERRORS

As mentioned in the 'RETURN VALUE' section, invalid values get useless results.

EXAMPLES

  my $rc = FameHLI::API::Cfmxxx(arg_list);
  printf("Cfmini said '%s'\n", FameHLI::API::EXT::ErrDesc($rc));

ENVIRONMENT

You will need to have the FAME environment variable set as noted in the Fame documentation.

FILES

As with any installation using the Fame software, you will need current license files in the path list specified by either the FAME or FAME_PATH environment variables.

CAVEATS (WARNINGS)

This module has not yet been tested against a Windows installation. If you do try it there and it works, please let me know. If it doesn't work, please let me know how you fixed it. :-)

BUGS/TODO

None known at this time.

RESTRICTIONS

You will need to already have FAME installed on your system. This module was developed using FAME 8.0.32 and 8.2.3(beta).

Just as the C-HLI is not thread-safe, neither is this library since it is based entirely on libchli. You have been warned.

SEE ALSO

perl(1) FameHLI::API(1) FameHLI::API::HLI(1).

AUTHOR

Dave Oberholtzer (daveo@obernet.com)

HISTORY