- 2.3.6 The LogfileGroup Class
- 2.3.6.1 LogfileGroup Methods
[+/-]
- 2.3.6.1.1.
LogfileGroupConstructor - 2.3.6.1.2.
LogfileGroup::getName() - 2.3.6.1.3.
LogfileGroup::getUndoBufferSize() - 2.3.6.1.4.
LogfileGroup::getAutoGrowSpecification() - 2.3.6.1.5.
LogfileGroup::getUndoFreeWords() - 2.3.6.1.6.
LogfileGroup::getObjectStatus() - 2.3.6.1.7.
LogfileGroup::getObjectVersion() - 2.3.6.1.8.
LogfileGroup::getObjectId() - 2.3.6.1.9.
LogfileGroup::setName() - 2.3.6.1.10.
LogfileGroup::setUndoBufferSize() - 2.3.6.1.11.
LogfileGroup::setAutoGrowSpecification()
Abstract
This section provides descriptions for the public methods of the
LogfileGroup class.
Description. The LogfileGroup class has two public constructors, one of which takes no arguments and creates a completely new instance. The other is a copy constructor.
Note
The Dictionary class also supplies methods
for creating and destroying LogfileGroup
objects. See Section 2.3.3, “The Dictionary Class”.
Signatures. New instance:
LogfileGroup
(
void
)
Copy constructor:
LogfileGroup
(
const LogfileGroup& logfileGroup
)
Parameters.
When creating a new instance, the constructor takes no
parameters. When copying an existing instance, the constructor
is passed a reference to the LogfileGroup
instance to be copied.
Return value.
A LogfileGroup object.
Destructor.
virtual ~LogfileGroup
(
void
)
Examples.
[To be supplied...]
Description. This method gets the name of the logfile group.
Signature.
const char* getName
(
void
) const
Parameters. None.
Return value. The logfile group's name, a string (as a character pointer).
Description.
This method retrieves the size of the logfile group's
UNDO buffer.
Signature.
Uint32 getUndoBufferSize
(
void
) const
Parameters. None.
Return value.
The size of the UNDO buffer, in bytes.
Description.
This method retrieves the
AutoGrowSpecification associated with the
logfile group.
Signature.
const AutoGrowSpecification& getAutoGrowSpecification
(
void
) const
Parameters. None.
Return value.
An AutoGrowSpecification data structure.
See Section 2.3.26, “The AutoGrowSpecification Structure”, for details.
Description.
This method retrieves the number of bytes unused in the
logfile group's UNDO buffer.
Signature.
Uint64 getUndoFreeWords
(
void
) const
Parameters. None.
Return value. The number of bytes free, as a 64-bit integer.
Description.
This method is used to obtain the object status of the
LogfileGroup.
Signature.
virtual Object::Status getObjectStatus
(
void
) const
Parameters. None.
Return value.
The logfile group's Status — see
Section 2.3.20.1.3, “The Object::Status Type” for possible values.
Description. This method gets the logfile group's object version.
Signature.
virtual int getObjectVersion
(
void
) const
Parameters. None.
Return value. The object version of the logfile group, as an integer.
Description. This method is used to retrieve the object ID of the logfile group.
Signature.
virtual int getObjectId
(
void
) const
Parameters. None.
Return value. The logfile group's object ID (an integer value).
Description. This method is used to set a name for the logfile group.
Signature.
void setName
(
const char* name
)
Parameters.
The name to be given to the logfile
group (character pointer).
Return value. None.
Description.
This method can be used to set the size of the logfile group's
UNDO buffer.
Signature.
void setUndoBufferSize
(
Uint32 size
)
Parameters.
The size in bytes for the
UNDO buffer (using a 32-bit unsigned
integer value).
Return value. None.
Description.
This method sets to the
AutoGrowSpecification data for the logfile
group.
Signature.
void setAutoGrowSpecification
(
const AutoGrowSpecification& autoGrowSpec
)
Parameters.
The data is passed as a single parameter, an
AutoGrowSpecification data structure
— see Section 2.3.26, “The AutoGrowSpecification Structure”.
Return value. None.
