OpenEntity

Description: Opens an entity in the database currently open in the HSFWebService.

Prerequisites: CreateSession(), OpenServer() and OpenDatabase().

Syntax

Visual Basic

Public Function OpenEntity( _ 
   ByVal sessionID As String,  _ 
   ByVal entity As String,  _ 
   ByVal checkOut As Boolean _ 
) As DataSet

public DataSet OpenEntity(
   string sessionID, 
   string entity, 
   bool checkOut
)

C++

public:
 DataSet OpenEntity(
   String sessionID, 
   String entity, 
   bool checkOut
) sealed

JScript

public  function OpenEntity(
   sessionID : String, 
   entity : String, 
   checkOut : bool
) : DataSet

Parameters

Table 16. Parameters

Parameter	Data Type	Description
sessionID	string	A session identifier
entity	string	An entity name
checkOut	bool	True—check out entity False—open as copy

Returns

DataSet

Table 17. OpenEntity DataSet

Parameter	Data Type	Description
Name	String	Name of entity
IsCheckedOut	boolean	Checked out status: true Is checked out false Is not checked out

Example