Deletes an existing object from the server or client object system.
Syntax
EsbDeleteObject (hCtx, ObjType, AppName, DbName, ObjName) ByVal hCtx As Long ByVal ObjType As Long ByVal AppName As String ByVal DbName As String ByVal ObjName As String
Parameter | Description |
---|---|
hCtx | VB API context handle. Can be local context handle returned by EsbCreateLocalContext(). |
ObjType | Object type (must be single type). Refer to Table 15 for a list of possible values. |
AppName | Application name. |
DbName | Database name. If an empty string, uses the application sub-directory. |
ObjName | Object name to delete. |
Notes
To delete an object, the object must not be locked.
Outline objects cannot be deleted. Use the EsbDeleteDatabase() function to delete a database, including its associated outline.
Return Value
None.
Access
This function requires the caller to have application or database Design privilege (ESB_PRIV_APPDESIGN or ESB_PRIV_DBDESIGN) for the specified application or database containing the object.
Example
Declare Function EsbDeleteObject Lib "ESBAPIN" (ByVal hCtx As Long, ByVal ObjType As Integer, ByVal AppName As String, ByVal DbName As String, ByVal ObjName As String) As Long Sub ESB_DeleteObject () Dim sts As Long Dim AppName As String Dim DbName As String Dim ObjName As String Dim ObjType As Integer AppName = "Sample" DbName = "Basic" ObjName = "Basic" ObjType = ESB_OBJTYPE_RULES '******************** ' Delete Rules Object '******************** sts = EsbDeleteObject (hCtx, ObjType, AppName, DbName, ObjName) End Sub
See Also