National Center for Biotechnology Information

#include <ncbi.h>

Int2 Main()
{
    if
(!DoSearch("swissprot","query.aa",12,0.1,"blast.out"))
          return 1;  /* failure */

    return 0;   /* success */
}
typedef struct {
    char *prompt;         /* Visible prompt for user */
    char *defaultvalue;   /* Default value */
    char *from;                /* Low value in allowed range */
    char *to;             /* High value in allowed range */
    Boolean    optional;  /* Is this argument optional? */
    char  tag;            /* Command-line switch */
    Int1  type;           /* Data type */
    FloatHi    floatvalue;     /* Returned floating point value */
    Int4  intvalue;       /* Returned integer value */
    CharPtr    strvalue;  /* Returned string value */
} Arg, *ArgPtr;
#include <ncbi.h>

Arg arg[] = {
 
{"Database","nr",NULL,NULL,FALSE,'D',ARG_STRING,0.0,0,
NULL},
  {"Query
file","query.aa",NULL,NULL,FALSE,'Q',ARG_FILE_IN,0.0,0, NULL},
 
{"Threshold","13","5","25",TRUE,'T',ARG_BOOLEAN,0.0,0,NULL},
 
{"Expect","0.1","0.01","10",TRUE,'E',ARG_FLOAT,0.0,0,NULL
},
  {"Output
file","blast.out",NULL,NULL,FALSE,'O',ARG_FILE_OUT,0.0,0,
NULL}};

Int2 Main()
{
    if (!GetArgs("demo",DIM(arg),arg))
          return 1;  /* failure */

    if (!DoSearch(arg[0].strvalue,arg[1].strvalue,
               arg[2].intvalue,arg[3].floatvalue,arg[4].strvalue))
          return 1;  /* failure */

    return 0;   /* success */
}
typedef enum MsgAnswser
{
    ANS_NONE,
    ANS_OK,
    ANS_CANCEL,
    ANS_ABORT,
    ANS_RETRY,
    ANS_IGNORE,
    ANS_YES,
    ANS_NO
}
MsgAnswer LIBCALLBACK MyMessageHook (MsgKey key, ErrSev sev,
               const char *caption, const char *message)
{
    MsgAnswer answer;

    /* Create a dialog box using caption as the title.  Within
    *  content region, show message and an icon selected using
    *  sev.  Place buttons on the dialog based on the value of
    *  key.  Wait for the user to press a button, then destroy
    *  the dialog window and return the appropriate answer code. */

    return answer;
}
void LIBCALLBACK MyBeepHook ()
{
    PlaySoundFile("beep.snd");

}

Int2 Main ()
{
    SetBeepHook(MyBeepFunction);

         ...etc...

    return 0;
}
int LIBCALLBACK MyMonitorHook (Monitor *mon, MonCode code)
{
    switch (code)
    {
          case MonCode_Create :
               /* allocate memory & create interface elements
here */
               if (failure)
                     return FALSE;
               break;
          case MonCode_Destroy :
               /* free memory & destroy interface elements here
*/
               break;
          case MonCode_IntValue :
               /* */
               break;
          case MonCode_StrValue :
               /* */
               break;
          default :
               return FALSE;
    }
    return TRUE;

}
Boolean LIBCALLBACK MyProgMonHook (VoidPtr data, CharStr str);
Monitor *defProgMon;

Int Main ()
{
    defProgMon = MonitorStrNew(“Progress Messages”,80);
    SetProgMon(MyProgMonHook,(void*)defProgMon);

         ... do stuff
...

    MonitorFree(defProgMon);
    return 0;

}

Boolean LIBCALLBACK MyProgMonHook (void *data, const char *str)
{
    return MonitorStrValue((Monitor*)data,str);
}
[General]
AsnLoad = c:\ncbi\asnload
AsnData = c:\ncbi\asndata

[CD-ROM]
path = E:\

[NetService]
; Note: set USERNAME = ? to be prompted for your username
username=?
host=dispatcher@ncbi.nlm.nih.gov
timeout=30
#ifndef THIS_MODULE
#define THIS_MODULE  NULL
#endif
#ifndef THIS_FILE
#define THIS_FILE  __FILE__
#endif
static char *this_module = "MyModule";
#define THIS_MODULE  this_module
static char *this_file = __FILE__;
#define THIS_FILE this_file

#include <ncbi.h>

[ErrorProcessing]

;  need to tell the system where the message files are kept
MsgPath=/sun/ncbi/errmsg

SEV_INFO    = "==> note    "
SEV_WARNING = "==> WARNING "
SEV_ERROR   = "==> ERROR   "
SEV_FATAL   = "==> FATAL   "

;  override a few of the option flags
EO_SHOW_MSGTEXT = 1   ;always show me everything...
EO_BEEP = 0           ;...but those beeps drive me nuts
MODULE CoreLib

$$ NoMemory, 1, SEV_FATAL

$$ File, 2, SEV_INFO

$^   Open, 1
This often indicates that the file simply does not exist.
Alternatively, it may exist but you do not have permission to
access the file in the requested mode.

$^   Read, 2
Not sure what would cause this...

$^   Write, 3, SEV_FATAL
This may indicate that the filesystem is full.

$$ Math, 3
$^   Param, 1
$^   Domain, 2
$^   Range, 3
$^   Iter, 4

$$ SGML, 4
$^   Init, 1
$^   Braces, 2
$^   Entity, 3
#include <ncbi.h>

int LIBCALLBACK MyErrorHandler (const ErrDesc *err)
{
    if (strcmp(err->cntxstr,"CoreLib") ==0 &&
               err->errcode == E_NoMemory)
    {
          Beep(); Beep(); Beep(); /* something they'll notice! */
          ReleaseLifeboat(); /* free up memory reserves */
          return ErrShow();
    }
    return 0;  /* zero means we didn't handle the error */
}

int main (int argc, char **argv)
{
    ErrSetHandler(MyErrorHandler);

    ... do stuff ...

    return 0;
}

FILE* LIBCALLBACK  MyFileOpenHook (const char *fname, const char
*fmode);

Int 2 Main ()
{
    SetFileOpenHook (myFileOpenHook);

    ... do stuff ...

    return 0;

}

FILE* LIBCALLBACK  MyFileOpenHook (const char *fname, const char
*fmode)
{
    /* Note:  FileOpen checks for NULL arguments, so we don’t
          have to do it here */

    char *p = strchr(fname,DIRDELIMCHR);
    if (p != NULL)
    {
          FILE *fd = fopen(p+1,fmode);
          if (fd != NULL)
               return fd;
    }
    return fopen(fname,fmode);

}
typedef union dataval
{
    VoidPtr ptrvalue;
    Int4 intvalue;
    FloatHi realvalue;
    Boolean boolvalue;
} DataVal, *DataValPtr;

typedef struct valnode
{
    Uint1 choice;              /* to pick a choice */
    DataVal data;              /* attached data */
    struct valnode *next;      /* next in linked list */
} ValNode, *ValNodePtr;
Int2 StringCmp PROTO((CharPtr str1, CharPtr str2));
Int2 Message VPROTO((Int2 key, char *fmt, ...));
Datatype Symbol	Data Type Description	Storage Field in Arg
ARG_BOOLEAN	TRUE/FALSE value	intvalue
ARG_INT	Integer value	intvalue
ARG_FLOAT	Floating point value	floatvalue
ARG_STRING	String value	strvalue
ARG_FILE_IN	Name of input file	strvalue
ARG_FILE_OUT	Name of output file	strvalue
ARG_DATA_IN	Datalink in	strvalue [[ VERIFY ]]
ARG_DATA_OUT	Datalink out	strvalue [[ VERIFY ]]
Platform	File Name	Locations searched
UNIX	.xxxrc	1. Path from NCBI environment variable 2. User's home directory 3. Current working directory
VMS	.xxxrc	1. Path from NCBI environment variable 2. User's home directory 3. Current working directory
Macintosh	xxx.cnf	1. System Folder:Preferences 2. System Folder
MS-DOS	xxx.cfg	1. Path from NCBI environment variable 2. Current directory
MS-Windows	xxx.ini	1. Windows directory
NCBI Toolbox	ANSI C	Description
FileOpen	fopen	Opens a file for reading or writing
FileClose	fclose	Closes an open file
FileRead	fread	Reads bytes from an open file
FileWrite	fwrite	Writes bytes to an open file
FileGets	fgets	Reads a string from an open file
FilePuts	fputs	Writes a string to an open file
Parameter	Operating System	Description
sVolume	MacOS	Volume name, e.g. “SEQDATA”
deviceName	UNIX	Name of CD-ROM device, e.g. “/dev/sr0”
rawDeviceName	UNIX	Name of raw device, e.g. “dev/rsr0”
mountPoint	UNIX, VMS	Filesystem location where CD-ROM data should be mounted, e.g. “/cdrom”
mountCmp	UNIX	A script or program that performs the ejecting and mounting actions. For many UNIX systems, mounting requires super-user privileges
NCBI Toolkit	ANSI C	Description
Malloc	malloc	Allocates memory
Calloc	calloc	Allocates memory
Realloc	realloc	Changes the size of a previously allocated block.
Free	free	Frees a memory block.
MemCopy	memcpy	Copies a range of bytes .
MemMove	memmove	Copies a range of bytes (source and destination may overlap).
MemFill	memset	Sets a range of bytes to a particular value.
Macro	Description
LN2	Natural logarithm of 2
LN10	Natural logarithm of 10
EXP2(x)	Base-2 exponential of x
LOG2(x)	Base-2 logarithm of x
EXP10(x)	Base-10 exponential of x
LOG10(x)	Base-10 logarithm of x
Macro	Description
ABS(a)	Returns the absolute value of a (any numerical type).
SIGN(a)	Returns -1 if a is negative, +1 if it is positive, or 0 if it is zero.
MIN(a,b)	Returns the maximum of a and b (any numerical type).
MAX(a,b)	Returns the minimum of a and b (any numerical type).
ROUNDUP(a,b)	Rounds a up to the nearest multiple of b.
DIM(a)	Returns the dimension (number of elements) in the array a.
Filename	Hardware	Operating System	Compiler
ncbilcl.370	IBM 370	AIX	System V cc
ncbilcl.acc	Sun SPARC	SunOS	Sun acc
ncbilcl.alf	DEC Alpha-XP	OSF/1	DEC C compiler
ncbilcl.aov	DEC Alpha-XP	OpenVMS	BSD cc
ncbilcl.aux	Macintosh 68K	AU/X	AU/X
ncbilcl.bor	Intel PC	MS-DOS	Borland C/C++
ncbilcl.bwn	Intel PC	Windows DOS	Borland C/C++
ncbilcl.ccr	Sun SPARC	SunOS	CodeCenter
ncbilcl.cpp	Sun SPARC	SunOS	Sun C++
ncbilcl.cra	Cray YMP	Unicos	Cray C compiler
ncbilcl.cvx	CONVEX	UNIX System V	BSD cc
ncbilcl.gcc	Sun SPARC	SunOS	Gnu gcc or g++
ncbilcl.hp	HP PA-RISC	HP-UX	System V cc
ncbilcl.mpw	Macintosh 68K	MacOS	Apple MPW C
ncbilcl.msc	Intel PC	MS-DOS	Microsoft C
ncbilcl.msw	Intel PC	Windows DOS	Microsoft C
ncbilcl.nxt	Next	NextStep	Next C compiler
ncbilcl.r6k	IBM RS 6000	AIX	System V cc
ncbilcl.sgi	SGI MIPS	UNIX System V	System V cc
ncbilcl.sol	Sun SPARC	Sun Solaris	SunPro
ncbilcl.sun	Sun SPARC	SunOS	BSD cc
ncbilcl.thc	Macintosh 68K	MacOS	Symantec C/C++
ncbilcl.ult	DEC MIPS	ULTRIX	System V cc
ncbilcl.vms	VAX	OpenVMS	BSD cc
Type	Description	Size	Min. Value	Max. Value
Boolean	A TRUE or FALSE value	1	FALSE	TRUE
Byte	Smallest unit of storage that a C program can address (unsigned)	1	0	UINT_MAX
Char	ASCII character occupying one byte of storage (may be either signed or unsigned)	1	CHAR_MIN	CHAR_MAX
Uchar	Unsigned ASCII character	1	UCHAR_MIN	UCHAR_MAX
Int1	Signed integer, 1 byte	1	INT1_MIN	INT1_MAX
Uint1	Unsigned integer, 1 byte	1	0	UINT1_MAX
Int2	Signed integer, 2 bytes	2	INT2_MIN	INT2_MAX
Uint2	Unsigned intege, 2 bytes	2	0	UINT2_MAX
Int4	Signed integer, 4 bytes	4	INT4_MIN	INT4_MAX
Uint4	Unsigned integer, 4 bytes	4	0	UINT4_MAX
Type,	Description
VoidPtr	Generic pointer (same as Pointer)
BoolPtr	Pointer to Boolean
BytePtr	Pointer to Byte
CharPtr	Pointer to Char
UcharPtr	Pointer to Uchar
Int1Ptr	Pointer to Int1
Uint1Ptr	Pointer to Uint1
Int2Ptr	Pointer to Int2
Uint2Ptr	Pointer to Uint2
Int4Ptr	Pointer to Int4
Uint4Ptr	Pointer to Uint4
FloatHiPtr	Pointer to FloatHi
FloatLoPtr	Pointer to FloatLo
FnPtr	Generic function pointer
Pointer	Generic pointer (same as VoidPtr)
Handle	Generic handle. Points to a block of memory that is moveable on Macintosh & Windows. On other platforms it is the same as a Pointer