Selection

_Org_CurrSel_Presentation, _Org_CurrSel_PresentationEx, Org_CurrSel_GetFieldValue, Org_CurrSel_GetFieldValueEx, Org_CurrSel_GetRecordCount, Org_CurrSel_GetRecordCountEx, Org_CurrSel_OpenImage, Org_CurrSel_OpenImageEx, Org_InvertSelection, Org_InvertSelectionEx, Org_SelectAll, Org_SelectAllEx, Org_SelectRange, Org_SelectRangeEx, Org_SelectRecord, Org_SelectRecordEx

Org_CurrSel_GetFieldValue

Description 

 Org_CurrSel_GetFieldValue(
   int  SelectionIndex,
   char *FieldName,
   char *ReturnValue,
   int  ValueLength
);

Function retrieves value of the specified record and field. The function acts only above selected records in 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 SelectionIndex

Index of the record among the currently selected record. Typically this value should be 0 if only one record is selected.

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.

Org_CurrSel_GetFieldValueEx

Description 

 Org_CurrSel_GetFieldValueEx(
   int  DataSource,
   int  SelectionIndex,
   char *FieldName,
   char *ReturnValue,
   int  ValueLength
);

Function retrieves value of the specified record and field. The function acts only above selected 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.

int SelectionIndex

Index of the record among the currently selected record. Typically this value should be 0 if only one record is selected.

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.

Org_CurrSel_GetRecordCount

Description 

int Org_CurrSel_GetRecordCount();

Returns the number of currently selected records in the active datasource.

Return Values

int

Org_CurrSel_GetRecordCountEx

Description 

int Org_CurrSel_GetRecordCountEx(
   int  DataSource
);

Returns the number of currently selected 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.

Return Values

int

Org_CurrSel_OpenImage

Description 

 Org_CurrSel_OpenImage(
   int  SelectionIndex
);

Function opens the image of the specified record. The function acts only above selected records in active datasource.

Parameters

int SelectionIndex

Index of the record among the currently selected record. Typically this value should be 0 if only one record is selected.

Org_CurrSel_OpenImageEx

Description 

 Org_CurrSel_OpenImageEx(
   int  DataSource,
   int  SelectionIndex,
   char *FieldName,
   int  Refresh
);

Function opens the image of the specified record. The function acts only above selected 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 SelectionIndex

Index of the record among the currently selected record. Typically this value should be 0 if only one record is selected.

char *FieldName

Name or unique name of the field.

int Refresh

Flag to force open next location change.

0

Do not change open next location.

1

Change open next location.

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.

Org_InvertSelection

Description 

 Org_InvertSelection();

The function inverts the selection in the active datasource. All selected items will be marked as unselected and all unselected items will be marked as selected.

Org_InvertSelectionEx

Description 

 Org_InvertSelectionEx(
   int  DataSource
);

The function inverts the selection in the specified datasource. All selected items will be marked as unselected and all unselected items will be marked as selected.

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.

Org_SelectAll

Description 

 Org_SelectAll(
   int  Select
);

The function selects/deselects all items in the active datasource.

Parameters

int Select

Flag whether select or deselect all items.

0

Deselect all items.

1

Select all items.

Org_SelectAllEx

Description 

 Org_SelectAllEx(
   int  DataSource,
   int  Select
);

The function selects/deselects all items 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 Select

Flag whether select or deselect all items.

0

Deselect all items.

1

Select all items.

Org_SelectRange

Description 

 Org_SelectRange(
   int  RecordIndexFrom,
   int  RecordIndexTo,
   int  Select
);

The function selects/deselects all items from the specified interval in the active datasource.

Parameters

int RecordIndexFrom

Index of the first record to select or deselect.

int RecordIndexTo

Index of the last record to select or deselect.

int Select

Flag whether select or deselect all items.

0

Deselect all items.

1

Select all items.

Org_SelectRangeEx

Description 

 Org_SelectRangeEx(
   int  DataSource,
   int  RecordIndexFrom,
   int  RecordIndexTo,
   int  Select
);

The function selects/deselects all items from the specified interval in 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.

int RecordIndexFrom

Index of the first record to select or deselect.

int RecordIndexTo

Index of the last record to select or deselect.

int Select

Flag whether select or deselect all items.

0

Deselect all items.

1

Select all items.

Org_SelectRecord

Description 

 Org_SelectRecord(
   int  RecordIndex,
   int  Select
);

The function selects/deselects the specified item in the active datasource.

Parameters

int RecordIndex

Index of the record.

int Select

Flag whether select or deselect all items.

0

Deselect all items.

1

Select all items.

Org_SelectRecordEx

Description 

 Org_SelectRecordEx(
   int  DataSource,
   int  RecordIndex,
   int  Select
);

The function selects/deselects the specified item 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 RecordIndex

Index of the record.

int Select

Flag whether select or deselect all items.

0

Deselect all items.

1

Select all items.

_Org_CurrSel_Presentation

Description 

 _Org_CurrSel_Presentation();

This function starts a presentation of the images of the current directory (selected in the organizer view) according to the user settings. A dialog window appears.

Note

If there are no image files in the current directory, no action is performed.

_Org_CurrSel_PresentationEx

Description 

 _Org_CurrSel_PresentationEx(
   int  DataSource
);

This function starts a presentation of the images of the current directory (selected in the organizer view) according to the user settings. The source pane (left or right) of the organizer can be set. A dialog window appears.

Parameters

int DataSource

Select a pane of the organizer the system will use as the image data source. It doesn't matter if it is currently hidden or not.

0

The left pane

1

The right pane

See Also 
_Org_CurrSel_Presentation