ajfiledata.c

Datatypes: AjPFile

Datatype: AjPFile

File object

Sections: File Constructors data file values file exit

Section: File Constructors

Functions: ajDatafileNewInNameC ajDatafileNewInNameS ajDatafileNewInNamePathS ajDatafileNewOutNameS

Function ajDatafileNewInNameC

Returns an allocated data file pointer (AjPFile) if file exists a) in . b) in ./.embossdata c) ~/ d) ~/.embossdata e) $DATA

Synopsis

Prototype
AjPFile ajDatafileNewInNameC (
      const char* name
);

TypeNameRead/WriteDescription
const char*nameInputFilename.
AjPFile RETURNfile pointer

Input
name:(Input)Filename.
Returns
AjPFile:file pointer

Description

Returns an allocated data file pointer (AjPFile) if file exists a) in . b) in ./.embossdata c) ~/ d) ~/.embossdata e) $DATA

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajDatafileNewInNameS

Returns an allocated data file pointer (AjPFile) if file exists a) in . b) in ./.embossdata c) ~/ d) ~/.embossdata e) $DATA

Synopsis

Prototype
AjPFile ajDatafileNewInNameS (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputFilename
AjPFile RETURNfile pointer

Input
name:(Input)Filename
Returns
AjPFile:file pointer

Description

Returns an allocated data file pointer (AjPFile) if file exists a) in . b) in ./.embossdata c) ~/ d) ~/.embossdata e) $DATA

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajDatafileNewInNamePathS

Returns an allocated AjFileInNew pointer (AjPFile) if file exists in the EMBOSS/data/(dir) directory, or is found in the usual directories by ajDatafileNewInNameS

Synopsis

Prototype
AjPFile ajDatafileNewInNamePathS (
      const AjPStr name,
      const AjPStr path
);

TypeNameRead/WriteDescription
const AjPStrnameInputFilename in AjStr.
const AjPStrpathInputData directory name in AjStr.
AjPFile RETURNfile pointer

Input
name:(Input)Filename in AjStr.
path:(Input)Data directory name in AjStr.
Returns
AjPFile:file pointer

Description

Returns an allocated AjFileInNew pointer (AjPFile) if file exists in the EMBOSS/data/(dir) directory, or is found in the usual directories by ajDatafileNewInNameS

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajDatafileNewOutNameS

Returns an allocated output data file pointer (AjPFile) to a file in the emboss_DATA area

Synopsis

Prototype
AjPFile ajDatafileNewOutNameS (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputFilename in AjStr.
AjPFile RETURNfile pointer.

Input
name:(Input)Filename in AjStr.
Returns
AjPFile:file pointer.

Description

Returns an allocated output data file pointer (AjPFile) to a file in the emboss_DATA area

See Also

See other functions in this section

Availability

In release 6.4.0

Section: data file values

Functions: ajDatafileValuePath

Function ajDatafileValuePath

Get the path to the active data directory

Synopsis

Prototype
const AjPStr ajDatafileValuePath (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNpath.

Returns
const AjPStr:path.

Description

Get the path to the active data directory

See Also

See other functions in this section

Availability

In release 6.4.0

Section: file exit

Functions: ajDatafileExit

Function ajDatafileExit

Prints a summary of file usage with debug calls

Synopsis

Prototype
void ajDatafileExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Prints a summary of file usage with debug calls

See Also

See other functions in this section

Availability

In release 6.4.0