Oid Structure

The object identifier containing a 32 bit database part, a 16 bit page part and a 16 bit page part. These parts are combined into a 64bit unsigned number Id.

Namespace: VelocityDb
Assembly: VelocityDb (in VelocityDb.dll) Version: 8.2.1.0 (8.2.1)

Syntax

C++

Copy

[SerializableAttribute]
public struct Oid : IComparable<Oid>, IEqualityComparer<Oid>

<SerializableAttribute>
Public Structure Oid
	Implements IComparable(Of Oid), IEqualityComparer(Of Oid)

[SerializableAttribute]
public value class Oid : IComparable<Oid>, 
	IEqualityComparer<Oid>

[<SealedAttribute>]
[<SerializableAttribute>]
type Oid =  
    struct
        interface IComparable<Oid>
        interface IEqualityComparer<Oid>
    end

The Oid type exposes the following members.

Constructors

	Name	Description
	Oid(UInt64)	Creates an Oid
	Oid(UInt32, UInt32)	Creates an Oid given a Database number and an OidShort (page-slot)
	Oid(UInt32, OidShort)	Creates an Oid given a Database number and an OidShort (page-slot)

Top

Properties

	Name	Description
	Database	Gets the database number part of the Oid
	Id	Gets the underlaying UInt64 that contains the encoded Oid.
	IdShort	Gets the page-slot parts of the underlaying UInt64 that contains the encoded Oid.
	Page	Gets the page number part of the Oid
	Slot	Gets the slot number part of the Oid

Top

Methods

	Name	Description
	AsString	Builds a string with DatabaseNumber-PageNumber-SlotNumber
	CompareTo	Compares two Oid objects by id
	DatabaseNumber	Extracts the Database number
	Encode(UInt32, UInt32)	Constructs a UInt64 from the components Database number and an encoded UInt32 contains page and slot number
	Encode(UInt32, UInt16, UInt16)	Constructs a UInt64 from the components Database number, Page number and page number
	Equals	Compares by Id
	GetHashCode	Computes a hash code based on Id. (Overrides ValueTypeGetHashCode.)
	GetHashCode(Oid)	Returns a hash code for the specified object.
	IdFromString
	PageNumber	Extracts the Page number
	SamePageAs	Find out if Page number is the same in two different UInt64 numbers (encoded Oid)
	SlotNumber(UInt64)	Extracts the page number
	SlotNumber(UInt64, UInt16)	Sets the page number
	ToString	Builds a string with DatabaseNumber-PageNumber-SlotNumber (Overrides ValueTypeToString.)

Top

Operators

	Name	Description
	GreaterThan	Compares the id of two Oid's
	GreaterThanOrEqual	Compares the id of two Oid's
	LessThan	Compares the id of two Oid's
	LessThanOrEqual	Compares the id of two Oid's

Top

Reference

VelocityDb Namespace