PinOption (OraRef) Property

Applies To

OraRef Object


Gets and sets the Pin option for the referenceable object during the pin operation.


pin_option = OraRef.PinOptionOraRef.PinOption = pin_option


Arguments Description
[in] PinOption An Integer representing the Pin option.

Data Type

Integer (Boolean)


Possible values returned by the pin_option property are:

Constant Value Description
ORAREF_READ_ANY 3 If the object is already in the object cache, returns it, otherwise, retrieves it from the database(default).
ORAREF_READ_RECENT 4 If the object is retrieved into the cache during a transaction, returns it from the cache, otherwise retrieves the object from the database.
ORAREF_READ_LATEST 5 Always retrieves the latest values from the database.


The following example shows the usage of the PinOption property. Before running the sample code, make sure that you have the necessary data types and tables in the database. See "Schema Objects Used in the OraObject and OraRef Examples".

Dim OraSession as OraSession
Dim OraDatabase as OraDatabase
Dim OraDynaset as OraDynaset
Dim Person as OraRef
'Create the OraSession Object.
Set OraSession = CreateObject("OracleInProcServer.XOraSession")
'Create the OraDatabase Object by opening a connection to Oracle.
Set OraDatabase = OraSession.OpenDatabase("ExampleDb", "scott/tiger", 0&)
'create a dynaset object from customers
set OraDynaset = OraDatabase.CreateDynaset("select * from customers",  0&)
'retrieve a aperson column from customers. Here Value 
'property of OraField object returns Person OraRef
set Person = OraDynaset.Fields("aperson").Value
'set the ORAREF_READ_LATEST read option on the Person object. 
Person.PinOption = ORAREF_READ_LATEST 
'pin the Person Ref and get the latest copy of referenceable 
'object for Ref from the database
MsgBox Person.Name
MsgBox Person.Age