XDASrv Reference Manual
DeleteItem Method
See Also  Send Feedback
NSPlugin Namespace > GenericServer Class : DeleteItem Method




appItemHandle
The handle that was specified when the item was added.
Generic server callback method. Supported only by the Professional Edition generic server V5.1 or newer.
The specified item is deleted in the generic server cache. Only items that are not currently referenced by any client (not added to a group by a client) can be deleted.

Syntax

Visual Basic (Declaration) 
Public Shared Function DeleteItem( _
   ByVal appItemHandle As Integer _
) As Integer
Visual Basic (Usage)Copy Code
Dim appItemHandle As Integer
Dim value As Integer
 
value = GenericServer.DeleteItem(appItemHandle)
C# 
public static int DeleteItem( 
   int appItemHandle
)
Managed Extensions for C++ 
public: static int DeleteItem( 
   int appItemHandle
) 
C++/CLI 
public:
static int DeleteItem( 
   int appItemHandle
) 

Parameters

appItemHandle
The handle that was specified when the item was added.

Return Value

Success/failure code:
S_OK (0x0) the item was deleted
OPC_E_NOTFOUND (0xC0040011) an item with the specified handle couldn't be found
OPC_E_BADRIGHTS (0xC0040006) the item is in use and could not be deleted

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

Copyright © 2002-2011 Advosol Inc. All Rights Reserved.