API Guide
601355 Rev A Preface P-3
Preface
Purpose of
This Book
This book describes the VolServ application programming
interface (API). The API consists of functions, iterators,
symbolic names, type definitions, and data structures.
Using the API provides the programmer with the ability to
directly manipulate VolServ file system metadata and media.
Who Should
Read This
Book
This book is written for programmers who are creating or
modifying an application that requires tight control over data in
the file system managed by VolServ
How This
Book is
Organized
This book contains the following chapters:
Chapter 1: Getting Started — Describes API types and
naming conventions, dispatch routines and global
parameters,.and error handling.
Chapter 2: Functions — Alphabetical list of API function
calls.
Appendix A: Valid Status Fields — A matrix shows which
status fields are valid for each command.
Appendix B: Error Codes.
Appendix C: Mount Example.