_XOnDAO2_IndexInfo_VIs.vi

Description



IIDeleteII

This function is the destructor of the Index Info Handle.

Parameter

IIHandle - Handle of the Index Info (input)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH


Connector Pane

IIDeleteII


Controls and Indicators

cdlrn

IIHandle in

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.


IIGetFieldInfo

Returns the Name and the order of records in a field which contain the current index.

Parameters

error Errorcode of this operation: -1 if handle not initialized, 1 if function

works correct, -2 if Error.

iiHdl Handle of the Index Info

Index The Number of field which belong to this index

Name pointer to a string which contains the Field Name

NameLen max. length of a field name

Descending returns the order of records in a field

TRUE ( Z to A ) Descending

FALSE ( A to Z ) Ascending


Connector Pane

IIGetFieldInfo


Controls and Indicators

cdlrn

IIHandle

ci32

Index

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ci32

Length

cbool

Descending

idlrn

IIHandle out

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

FResult

iclst

FieldInfo

IIGetFields

returns the number of fields that contain this index

Parameters

error Errorcode of this operation: -1 if handle not initialized, 1 if function

works correct, -2 if Error.

iiHdl Handle of the Index Info

NumberFields Pointer to an integer which contains the number of fields


Connector Pane

IIGetFields


Controls and Indicators

cdlrn

IIHandle

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

IIHandle out

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

NumberFields

IINewII

This function is the constructor of the Index Info Handle.

Parameter

IIHandle - Handle of the Index Info (output)

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH


Connector Pane

IINewII


Controls and Indicators

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

IIHandle out

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.


IISetField


Connector Pane

IISetField


Controls and Indicators

cdlrn

IIHandle

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ci32

Size

idlrn

IIHandle out

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

FResult

IISetFieldInfo

Sets the Name and the order of records of a field which contain the current index.

Parameters

error Errorcode of this operation: -1 if handle not initialized, 1 if function

works correct, -2 if Error.

iiHdl Handle of the Index Info

Index The Number of field which belong to this index

Name pointer to a string which contains the Field Name

Descending the order of records in a field

TRUE ( Z to A ) Descending

FALSE ( A to Z ) Ascending

XOn Software GmbH


Connector Pane

IISetFieldInfo


Controls and Indicators

cdlrn

IIHandle

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

cstr

Name

ci32

Index

idlrn

IIHandle out

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

FResult

IISetName

Sets the Index Name.

Parameters

error Errorcode of this operation: -1 if handle not initialized, 1 if function

works correct, -2 if Error.

iiHdl Handle of the Index Info

Name pointer to a string which contains the index name


Connector Pane

IISetName


Controls and Indicators

cdlrn

IIHandle

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

cstr

Name

idlrn

IIHandle out

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

ii32

FResult

IISetPrimary

This VI defines a primary Index.

Paramters:

IIHandle - Handle of the Index Info

IIHandle out - Outcoming Handle

Primary - Boolean for Primary Index

error in - a cluster describing the error state before executing the current VI. If the error state is TRUE, the VI will just pass the error cluster and incoming handle, no operation will happen.

error out - a cluster that describes the error status after this VI executes. If the error status is TRUE, an error occured. The DAO Error message (AKA source) is combined from the DAO-dll-call, and, where available, additional input-parameters. The DAO Error codes are always defined as:

-1 Handle not initialized

-2 Error

XOn Software GmbH


Connector Pane

IISetPrimary


Controls and Indicators

cdlrn

IIHandle

ci32

Primary

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

IIHandle out

ii32

FResult

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.


IISetUnique

Sets a value that indicates whether an Index object represents a unique (key) index for a table.

Parameters

error Errorcode of this operation: -1 if handle not initialized, 1 if function

works correct, -2 if Error.

iiHdl Handle of the Index Info

Unique TRUE if the Index object represents a unique index.


Connector Pane

IISetUnique


Controls and Indicators

cdlrn

IIHandle

ci32

Unique

cclst

error in (no error)

The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.

idlrn

IIHandle out

ii32

FResult

iclst

error out

The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.