Knight Data Access Layer
DeleteByPrimaryKey<T> Method (DataHelper)
Example 




KellermanSoftware.NetDataAccessLayer Namespace > DataHelper Class : DeleteByPrimaryKey<T> Method
Generic class type
The value of the primary key
Delete an object by the primary key
Syntax
Public Function DeleteByPrimaryKey(Of T As {Class, New})( _
   ByVal primaryKey As Object _
) As Integer
Dim instance As DataHelper
Dim primaryKey As Object
Dim value As Integer
 
value = instance.DeleteByPrimaryKey(Of T)(primaryKey)
public int DeleteByPrimaryKey<T>( 
   object primaryKey
)
where T: class, new()
public: int DeleteByPrimaryKey<T>( 
   Object* primaryKey
) 
where T: ref class, gcnew()
public:
int DeleteByPrimaryKeygeneric<typename T>
( 
   Object^ primaryKey
) 
where T: ref class, gcnew()

Parameters

primaryKey
The value of the primary key

Type Parameters

T
Generic class type

Return Value

Number of records deleted
Example
//Get the current thread static safe instance of the helper
IDataHelper db = DataHelper.SessionFactory();
 
//Specify User Name and License Key from the receipt, leave blank for trial mode
//db.UserName = "John Smith 1234";
//db.LicenseKey = "asdfl219==";
 
//Open the database connection
db.OpenConnection();
 
//Create a new Person to save to the database
Person currentPerson = new Person();
currentPerson.FirstName = "John";
currentPerson.LastName = "Smith";
 
//Save it to the database 
db.Save(currentPerson);
 
int result = db.DeleteByPrimaryKey<Person>(currentPerson);
 
//This is the number of records deleted
Console.WriteLine(result);
 
//Close the connection
db.CloseConnection();
'Get the current thread static safe instance of the helper
Dim db As IDataHelper = DataHelper.SessionFactory()
 
'Specify User Name and License Key from the receipt, leave blank for trial mode
'db.UserName = "John Smith 1234"
'db.LicenseKey = "asdfl219=="
 
'Open the database connection
db.OpenConnection()
 
'Create a new Person to save to the database
Dim currentPerson As New Person()
currentPerson.FirstName = "John"
currentPerson.LastName = "Smith"
 
'Save it to the database 
db.Save(currentPerson)
 
Dim result As Integer = db.DeleteByPrimaryKey(Of Person)(currentPerson)
 
'This is the number of records deleted
Console.WriteLine(result)
 
'Close the connection
db.CloseConnection()
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

DataHelper Class
DataHelper Members