scan_api.c File Reference

Implements the scan related functions of the FRET API. More...

#include <stdlib.h>
#include <assert.h>
#include "fret.h"
#include "common.h"
#include "requesthandler.h"
#include "scans.h"

Include dependency graph for scan_api.c:

Functions
bool	fret_runScan (const BufferId bufferId, const PhaseId phaseId, const ScanId scanId)
	Run a scan or batch of scans on a buffer or all of the buffers.

---

Detailed Description

Implements the scan related functions of the FRET API.

---

Function Documentation

bool fret_runScan (  BufferId  bufferId, PhaseId  phaseId, ScanId  scanId )

Run a scan or batch of scans on a buffer or all of the buffers. If a Buffer ID is passed, then only that Buffer is scanned, otherwise all Buffers are scanned. If a Phase Id is specified then only the scans for that phase are applied. If a specific Scan Id is passed then only that scan is applied to the buffer(s). Parameters: bufferId  identifies an individual buffer using its Buffer Id. If it is zero then scan all buffers. phaseId  identifies the phase of scans to apply. If the value is zero then a Scan Id can be passed or else all scans will be applied. scanId  identifies the scan to apply. If it is zero then a Phase Id must be passed as a parameter or else all scans are applied. Returns: true if function completed successfully. false if the library couldn´t complete the scans. Query cause with fret_getError(). See also: fret_getError

---