DataSource

Org_GetActiveDataSource, Org_GetColumnName, Org_GetColumnNameEx, Org_GetExtension, Org_GetExtensionEx, Org_GetFieldValue, Org_GetFieldValueEx, Org_GetFileFolder, Org_GetFileFolderEx, Org_GetRecordCount, Org_GetRecordCountEx, Org_GetRecursive, Org_GetRecursiveEx, Org_SetExtension, Org_SetExtensionEx, Org_SetFileFolder, Org_SetFileFolderEx, Org_SetRecursive, Org_SetRecursiveEx, Org_SortTablesByNames

Org_GetActiveDataSource

Description 

int Org_GetActiveDataSource();

This function returns the index of the active datasource.

Return Values

int

If the function succeed, the return value is index of the active datasource. If the function fails, the return value is -1.

Note

Each of the panes in organizer has its own datasource. The datasource contains visible images, active filter, sorting and grouping.

Org_GetColumnName

Description 

 Org_GetColumnName(
   int  ColumnIndex,
   char *ColumnName,
   int  ValueLength
);

This function returns the name of specified column in the active datasource.

Parameters

int ColumnIndex

Index of the column which name is returned in the supplied buffer.

char *ColumnName

Buffer with the column name.

int ValueLength

Size (in characters) of the supplied buffer.

See Also 
Org_GetActiveDataSource, Org_GetColumnNameEx

Org_GetColumnNameEx

Description 

 Org_GetColumnNameEx(
   int  DataSource,
   int  ColumnIndex,
   char *ColumnName,
   int  ValueLength
);

This function returns the name of specified column in the specified datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

int ColumnIndex

Index of the column which name is returned in the supplied buffer.

char *ColumnName

Buffer with the column name.

int ValueLength

Size (in characters) of the supplied buffer.

See Also 
Org_GetActiveDataSource, Org_GetColumnName

Org_GetExtension

Description 

 Org_GetExtension(
   char *Extension,
   int  ValueLength
);

This function returns the current image file extensions filter of the active datasource.

Parameters

char *Extension

Buffer into which the currently selected extension filter of the active datasource should be stored.

int ValueLength

Size (in characters) of the supplied buffer.

See Also 
Org_GetExtensionEx, Org_GetFileFolder, Org_GetFileFolderEx, Org_GetRecursive, Org_GetRecursiveEx

Org_GetExtensionEx

Description 

 Org_GetExtensionEx(
   int  DataSource,
   char *Extension,
   int  ValueLength
);

This function returns the current image file extensions filter of the specified datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

char *Extension

Buffer into which the currently selected extension filter of the active datasource should be stored.

int ValueLength

Size (in characters) of the supplied buffer.

See Also 
Org_GetExtension, Org_GetFileFolder, Org_GetFileFolderEx, Org_GetRecursive, Org_GetRecursiveEx

Org_GetFieldValue

Description 

 Org_GetFieldValue(
   int  RecordIndex,
   char *FieldName,
   int  ReturnValue,
   int  ValueLength
);

This function retrieves value of the specified record and field. The function acts above all records in the active datasource. Function tries to find a field with the specified name as unique identifier. If fails, then tries to find a field with the specified name. For unique names of each field if the datasource contains file folder images see Comments section.

Parameters

int RecordIndex

Index of the record.

char *FieldName

Name or unique name of the field.

int ReturnValue

Buffer into which the required data should be stored.

int ValueLength

Size (in characters) of the supplied buffer.

Note

If the datasource points to a file folder, name of the fields can have only one of the following values: Filename, Path, Size, Filedate, Dimensions, Calibration, Optics, Type, SampleID, Author, Description, ImageID, Group, Capturing, Sampling, Location, Date, Conclusion, Info1, Info2.

See Also 
Org_GetFieldValueEx, Org_CurrSel_GetFieldValue, Org_CurrSel_GetFieldValueEx, Org_GetRecordCount, Org_GetActiveDataSource

Org_GetFieldValueEx

Description 

 Org_GetFieldValueEx(
   int  DataSource,
   int  RecordIndex,
   char *FieldName,
   char *ReturnValue,
   int  ValueLength
);

This function retrieves value of the specified record and field. The function acts above all records in the specified datasource. Function tries to find a field with the specified name as unique identifier. If fails, then tries to find a field with the specified name. For unique names of each field if the datasource contains file folder images see Comments section.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

int RecordIndex

Index of the record.

char *FieldName

Name or unique name of the field.

char *ReturnValue

Buffer into which the required data should be stored.

int ValueLength

Size (in characters) of the supplied buffer.

Note

If the datasource points to a file folder, name of the fields can have only one of the following values: Filename, Path, Size, Filedate, Dimensions, Calibration, Optics, Type, SampleID, Author, Description, ImageID, Group, Capturing, Sampling, Location, Date, Conclusion, Info1, Info2.

See Also 
Org_GetFieldValue, Org_CurrSel_GetFieldValue, Org_CurrSel_GetFieldValueEx, Org_GetRecordCount, Org_GetActiveDataSource

Org_GetFileFolder

Description 

 Org_GetFileFolder(
   char *FileFolder,
   int  ValueLength
);

This function retrieves the current folder of the active datasource.

Parameters

char *FileFolder

Buffer into which the current folder of the active datasource should be stored.

int ValueLength

Size (in characters) of the supplied buffer.

See Also 
Org_GetFileFolderEx, Org_GetExtensionEx, Org_GetExtension, Org_GetRecursive, Org_GetRecursiveEx

Org_GetFileFolderEx

Description 

 Org_GetFileFolderEx(
   int  DataSource,
   char *FileFolder,
   int  ValueLength
);

This function retrieves the current folder of the specified datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

char *FileFolder

Buffer into which the current folder of the active datasource should be stored.

int ValueLength

Size (in characters) of the supplied buffer.

See Also 
Org_GetExtension, Org_GetExtensionEx, Org_GetRecursive, Org_GetRecursiveEx

Org_GetRecordCount

Description 

int Org_GetRecordCount();

This function returns the number of records in the active datasource.

Return Values

int

See Also 
Org_GetRecordCountEx, Org_GetActiveDataSource, Org_CurrSel_GetRecordCountEx

Org_GetRecordCountEx

Description 

 Org_GetRecordCountEx(
   int  DataSource
);

This function returns the number of records in the specified datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

See Also 
Org_GetRecordCount, Org_GetActiveDataSource, Org_CurrSel_GetRecordCountEx

Org_GetRecursive

Description 

int Org_GetRecursive();

This function returns the flag for scanning subfolders. The flag is read from the active data.

Return Values

int

0

The subfolders are not included in the scanning list

1

The subfolders are included in the scanning list

-1

The function fails for some reason

See Also 
Org_GetRecursiveEx, Org_GetFileFolder, Org_GetFileFolderEx, Org_GetExtensionEx, Org_GetExtension

Org_GetRecursiveEx

Description 

0 Org_GetRecursiveEx(
   int  DataSource
);

This function returns the flag for scanning subfolders. The flag is read from the active datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

Return Values

0

The subfolders are not included in the scanning list

1

The subfolders are included in the scanning list

-1

The function fails for some reason

See Also 
Org_GetRecursive, Org_GetFileFolder, Org_GetFileFolderEx, Org_GetExtensionEx, Org_GetExtension

Org_SetExtension

Description 

 Org_SetExtension(
   char *Extension
);

This function changes the current image file extensions filter of the active datasource.

Parameters

char *Extension

Buffer into which the currently selected extension filter of the active datasource should be stored.

Org_SetExtension(".bmp") //it sets extension filter to Windows bitmaps

See Also 
Org_SetExtensionEx, Org_SetFileFolder, Org_SetFileFolderEx, Org_SetRecursive, Org_SetRecursiveEx

Org_SetExtensionEx

Description 

 Org_SetExtensionEx(
   int  DataSource,
   char *Extension,
   int  Refresh
);

This function changes the current image file extensions filter of the specified datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

char *Extension

Buffer into which the currently selected extension filter of the active datasource should be stored.

int Refresh

If this parameter is nonzero the required folder content is reload. Fg. in consequentive call of Org_SetFileFolder, Org_SetExtension and Org_SetRecursive the last call should have this flag 1 to force refresh.

Org_SetExtensionEx(0, ".bmp", 1); //it sets extension filter to Windows bitmaps

See Also 
Org_SetExtension, Org_SetFileFolder, Org_SetFileFolderEx, Org_SetRecursive, Org_SetRecursiveEx

Org_SetFileFolder

Description 

 Org_SetFileFolder(
   char *FileFolder
);

This function changes the current folder of the active datasource.

Parameters

char *FileFolder

Buffer from which the new folder of the active datasource should be read.

See Also 
Org_SetFileFolderEx, Org_SetExtension, Org_SetExtensionEx, Org_SetRecursive, Org_SetRecursiveEx

Org_SetFileFolderEx

Description 

 Org_SetFileFolderEx(
   int  DataSource,
   char *FileFolder,
   int  Refresh
);

This function changes the current folder of the specified datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

char *FileFolder

Buffer from which the new folder of the specified datasource should be read.

int Refresh

If this parameter is nonzero the required folder content is reload. Fg. in consequentive call of Org_SetFileFolder, Org_SetExtension and Org_SetRecursive the last call should have this flag 1 to force refresh.

See Also 
Org_SetFileFolder, Org_SetExtension, Org_SetExtensionEx, Org_SetRecursive, Org_SetRecursiveEx

Org_SetRecursive

Description 

 Org_SetRecursive(
   int  Recursive
);

This function changes the flag for scanning subfolders. The flag is set to the active datasource.

Parameters

int Recursive

Flag which specifies whether also all subfolders should be searched for the images.

0

Search the current folder only.

1

Search the current folder and all its subfolders.

See Also 
Org_SetRecursiveEx, Org_SetFileFolder, Org_SetFileFolderEx, Org_SetExtension, Org_SetExtensionEx

Org_SetRecursiveEx

Description 

 Org_SetRecursiveEx(
   int  DataSource,
   int  Recursive,
   int  Refresh
);

This function changes the flag for scanning subfolders. The flag is set to the specified datasource.

Parameters

int DataSource

Index of the datasource from which the data are read.

0

The datasource of the left pane.

1

The datasource of the right pane.

int Recursive

Flag which specifies whether also all subfolders should be searched for the images.

0

Search the current folder only.

1

Search the current folder and all its subfolders.

int Refresh

If this parameter is nonzero the required folder content is reloaded. Fg. in consequentive call of Org_SetFileFolder, Org_SetExtension and Org_SetRecursive the last call should have this flag 1 to force refresh.

See Also 
Org_SetRecursive, Org_SetFileFolder, Org_SetFileFolderEx, Org_SetExtension, Org_SetExtensionEx

Org_SortTablesByNames

Description 

 Org_SortTablesByNames(
   int  SortedTableNames
);

This function changes the global flag whether tables in lists should be sorted alphabetically or not.

Parameters

int SortedTableNames

Flag whether table names should be sorted alphabetically or not.

0

Do not sort table names.

1

Sort table names.