User`s guide

FUNCTIONS
SDK SECTION 11
Page 180
OA_SetString
unsigned int WINAPI OA_SetString (const char* const ModeName, const char* ModeParam, char*
StringValue, const unsigned int StringLen)
Description
This function is used to set values for string type acquisition parameters where the
new values are stored in memory. To commit changes to file call WriteToFile().
Parameters
const char* const ModeName: The name of the mode for which an acquisition parameter
is to be edited.
const char* const ModeParam: The name of the acquisition parameter to be edited.
char* StringValue: The value to assign to the acquisition parameter.
const unsigned int StringLen: The length of the input string.
Return
unsigned int
DRV_SUCCESS
DRV_P1INVALID
DRV_P2INVALID
DRV_P3INVALID
DRV_P4INVALID
DRV_OA_INVALID_STRING_LENGTH
DRV_OA_MODE_DOES_NOT_EXIST
All parameters accepted.
Null mode name.
Null mode parameter.
Null string value.
Invalid string length
One or more of the string parameters has
an invalid length, i.e. > 255.
The Mode does not exist.
See also
OA_GetString, OA_EnableMode, OA_WriteToFile
OA_WriteToFile
unsigned int WINAPI OA_WriteToFile (const char * const FileName , unsigned int FileNameLen)
Description
This function will write a User defined list of modes to the User file. The Preset file will not
be affected.
Parameters
const char* const FileName: The name of the file to be written to.
unsigned int FileNameLen: File name string length.
Return
unsigned int
DRV_SUCCESS
DRV_P1INVALID
DRV_OA_INVALID_STRING_LENGTH
DRV_OA_INVALID_FILE
DRV_ERROR_FILESAVE
DRV_OA_FILE_HAS_BEEN_MODIFIED
DRV_OA_INVALID_CHARS_IN_NAME
All parameters accepted.
Null filename
One or more of the string parameters has
an invalid length, i.e. > 255.
Data cannot be written to the Preset Andor
file.
Failed to save data to file.
File to be written to has been modified
since last write, local copy of file may not
be the same.
File name contains invalid characters.
See also
OA_AddMode, OA_DeleteMode