CdbDocument Object

See Also Example Methods Properties

A CdbDocument object includes information about one instance of an object. The object can be a database, saved table, query, or relationship (Microsoft Jet databases only).

Remarks

Each CdbContainer object has a Documents collection containing CdbDocument objects that describe instances of built-in objects of the type specified by the CdbContainer. The following table lists the type of object each CdbDocument describes, the name of its CdbContainer object, and the type of information CdbDocument contains.

CdbDocument	CdbContainer	Contains information about
Database	Databases	Saved database
Table or query	Tables	Saved table or query
Relationship	Relations	Saved relationship

Note Don't confuse the CdbContainer objects listed in the preceding table with the collections of the same name. The Databases CdbContainer object refers to all saved database objects, but the Databases collection refers only to database objects that are open in a particular workspace.

With a CdbDocument object, you can:

Use the Name property to return the name that a user or the Microsoft Jet database engine gave to the object when it was created.
Use the Container property to return the name of the CdbContainer object that contains the CdbDocument object.
Use the Owner property to set or return the owner of the object. To set the Owner property, you must have write permission for the CdbDocument object, and you must set the property to the name of an existing CdbUser or CdbGroup object.
Use the UserName or Permissions properties to set or return the access permissions of a user or group for the object. To set these properties, you must have write permission for the CdbDocument object, and you must set the UserName property to the name of an existing CdbUser or CdbGroup object.
Use the DateCreated and LastUpdated properties to return the date and time when the CdbDocument object was created and last modified.

Because a CdbDocument object corresponds to an existing object, you can't create new CdbDocument objects or delete existing ones. To refer to a CdbDocument object in a collection by its ordinal number or by its Name property setting, use either of the following syntax forms:

Documents[0]

Documents["name"]

CdbDocument Constructor Syntax

Use any one of the following three constructors. The qualifier 'CONSTRUCTOR' in the syntax models is provided to help readability. It has no syntactic value.

CONSTRUCTORCdbDocument(VOID);

This constructor creates an instance of the class. There are no parameters.

CONSTRUCTORCdbDocument(const CdbDocument &);

Type	Description
const CdbDocument &	Reference to an object.

This constructor creates a copy of the object referenced in the parameter.

CONSTRUCTORCdbDocument(DAODocument *pdoc,

BOOL bAddRef = FALSE);

Type	Argument	Description
DAODocument *	pdoc	A DAO Automation interface pointer corresponding to this DAO class.
BOOL	bAddRef =FALSE	Optional. A Boolean. If TRUE, the DAO Automation interface AddRef function is called.

DAO functionality is presented through pointers to DAO Automation interfaces. This constructor makes a DAO interface available in the form of a DAO class object that provides additional functionality.

This constructor is not required for typical use. It is provided to enable you to easily create a DAO class object if you have access to the corresponding DAO interface.

When the destructor for the DAO object is invoked, the underlying Automation interface's Release member is called. If Release decrements the interface's reference count to zero, the pointer to the Automation interface can be deleted. If you don't want this to happen (for example, because you want to discard the DAO object, but continue using the Automation interface), specify TRUE for the second parameter. The underlying Automation interface's AddRef member is called, which counterbalances the eventual call to Release.