CRecord
DESCRIPTION: Basic record type. All object to be placed in FlitBase file (accessed using CFlitBase class) must be inherited from this class. |
BASE CLASS(ES): CTag
PROPERTY(S):
1. | m_Size Contains entire record size. | 2. | m_RecordAttr Hold the record attributes. Record attribute can be a combination of this constants:
ATTR_RECORDARRAY, RATTR_SAVESTATE, RATTR_ISREF, RATTR_ATTACHED, RATTR_HIDDEN, RATTR_ALIVE, RATTR_SELECTED, RATTR_VALIDSLOT, ATTR_HAVEAREA, RATTR_HAVEITEM, RATTR_HAVEWND, RATTR_ACTIVE, ATTR_VIRTUAL, RATTR_OBJECT, RATTR_GENERIC, RATTR_DISABLED, RATTR_DONTATTACH, RATTR_WIZARDGENERATED, RATTR_SCRIPTGENERATED, RATTR_FLEXARRAY, RATTR_TYPEARRAY, RATTR_FIXARRAY, RATTR_TEXTARRAY, RATTR_NOCOPYCONTENTS. | 3. | m_HeadSize Size for the header (fixed structure portion) of the record. | 4. | m_UpdateCnt This memeber will be increament whed the record was updated. It's also can be considered as automatic version number. | 5. | m_Version Record version number | 6. | m_AppSpecAttr This is an attribute member that's can be specifically used by application. The code library function will never change this value. | 7. | m_SecurityVersion Currently not used. Reserved for security purpose. |
METHOD(S):
1. | GetBinDataSize Use this function to obtain the size for binary data appended to the record. | 2. | IsObject Test for an object record. Object record is a record with RATTR_OBJECT attribute. | 3. | IsRef Use the function to determine either the record is a reference. A reference will have RATTR_ISREF value in their attribute. | 4. | IsAContainer Test either the record is a container record. This type of the record will keeps one of the RATTR_RECORDARRAY, RATTR_FIXARRAY, RATTR_FLEXARRAY or RATTR_TYPEARRAY attribute. | 5. | IsRecArray A method to test either the record is a record array. A record array wili have RATTR_RECORDARRAY in their attribute. | 6. | IsFixArray Test to determine a fix array. Fix array is a record with RATTR_FIXARRAY attribute. | 7. | IsTypeArray This function used to determine either the record is a type array. A type array having RATTR_TYPEARRAY as an attribute. | 8. | IsFlexArray Use this function to determine either the record is a flexible array. A flexible array having RATTR_FLEXARRAY in their attribute. | 9. | IsTextArray This function will determine either the record is a text array. A text array will have RATTR_TEXTARRAY flag in its attribute. | 10. | Dump Dump current record states in log messages. | 11. | GetBinData Retreive binary data appended to the record. | 12. | GetText, GetTextW Retreive appending text from record. | 13. | HaveFrame Test the flags to determine either the record having frame items. The records that having frame items would marked with RATTR_HAVEITEM attribute. | 14. | HaveArea Test the object attribute to determine an object with area information. This type of objects having RATTR_HAVEAREA attribute. | 15. | FormatLabel Retrieve a formatted string according to the object contents. | 16. | GetLabel Retrieve the record label. | 17. | GetDescription Retrieve the record description text. | 18. | GetCode Retrieve the record code string. | 19. | GetFormatedSerial Retrieve formatted string for record id. | 20. | IsNoCopyContents Retreive either the record having RATTR_NOCOPYCONTENTS. |
CONTENT(S)/SUB-RECORD(S):
DERIVED CLASS(ES): CFixArray, CFlexArray, CTypeArray, CRecArray, CReference
COMMENT: All the record to be write into Flitbase file must be inherited ftom this class. This objects are managable using CRecordHnd handler class. |
|