EquipStateBrowseClose | Equipment Database Functions

Cicode Programming Reference > Cicode Function Categories > Equipment Database Functions > EquipStateBrowseClose

EquipStateBrowseClose

The EquipStateBrowseClose function terminates a browsing session and cleans up the resources used by the session. This function uses iSession as the argument which is previously returned by the EquipStateBrowseOpen function.

Syntax

INT EquipStateBrowseClose(LONG Session )

Session:

The handle to a browse session previously returned by a EquipStateBrowseOpen call

Return Value

Returns 0 if the equipment state database browse session has been closed successfully, otherwise an error is returned.

Related Functions

EquipStateBrowseOpen, EquipStateBrowseFirst, EquipStateBrowseGetField, EquipStateBrowseNext, EquipStateBrowseNumRecords, EquipStateBrowsePrev, EquipGetProperty

Example

ErrSet(1);
		INT error;
		fieldValue = EquipStateBrowseClose(iSession);
		error = IsError();

		IF(error <> 0) THEN
			//return error
			ELSE
			//successful

		ErrSet(0) 
			end