Professional Documents
Culture Documents
On-line Documentation
This is a printable version of Revision B of the on-line documentation for the Data Manipulation component.
Revision Record
Revision Date Help Topic Description of Change
B, Issue 2 Jan 2006 Updated for Data Manipulation Release 02.01.06
All Added confidentiality statement
SupplyPoints Updated Problem Determination SupplyPoints
B, Issue 1 Nov 2003 All Updated for Data Manipulation Release 02.01.00
A Oct 2002 All New documentation for the Data Manipulation component
version 02.00.00
Table of Contents
1. DATA MANIPULATION ..................................................................................................................................... 5
1.1 FUNCTIONAL OVERVIEW .................................................................................................................................... 5
1.2 USER GUIDE ....................................................................................................................................................... 5
1.2.1 Standard Data Record................................................................................................................................. 5
1.2.2 Standard Data Dictionary ........................................................................................................................... 5
1.2.3 Object Dictionary ....................................................................................................................................... 6
1.2.4 Troubleshooting.......................................................................................................................................... 6
1.3 REFERENCE ........................................................................................................................................................ 6
1.3.1 Standard Data Record Reference ................................................................................................................ 6
1.3.1.1 Standard Data Record Object Identification ............................................................................................................ 6
1.3.1.2 Standard Data Record Interfaces............................................................................................................................. 7
1.3.1.2.1 IDataRecord Interface..................................................................................................................................... 7
1.3.1.2.1.1 IDataRecord Properties............................................................................................................................ 7
1.3.1.2.1.1.1 RecordType Property..................................................................................................................... 7
1.3.1.2.1.2 IDataRecord Methods .............................................................................................................................. 7
1.3.1.2.1.2.1 GetFieldValue Method.................................................................................................................. 7
1.3.1.2.1.2.2 ListFields Method......................................................................................................................... 8
1.3.1.2.2 _StandardDataRecord Interface ...................................................................................................................... 8
1.3.1.2.2.1 _StandardDataRecord Properties.............................................................................................................. 8
1.3.1.2.2.1.1 RecordType Property..................................................................................................................... 8
1.3.1.2.2.2 _StandardDataRecord Methods................................................................................................................ 9
1.3.1.2.2.2.1 AddField Method .......................................................................................................................... 9
1.3.1.2.2.2.2 RemoveField Method .................................................................................................................... 9
1.3.2 Standard Data Dictionary Reference ......................................................................................................... 10
1.3.2.1 Standard Data Dictionary Object Identification ..................................................................................................... 10
1.3.2.2 Standard Data Dictionary Interfaces ..................................................................................................................... 10
1.3.2.2.1 IDataDictionary Interface ............................................................................................................................. 10
1.3.2.2.1.1 IDataDictionary Methods....................................................................................................................... 10
1.3.2.2.1.1.1 AddRecord Method ..................................................................................................................... 10
1.3.2.2.1.1.2 GetRecord Method...................................................................................................................... 11
1.3.2.2.1.1.3 RemoveRecord Method ............................................................................................................... 11
1.3.3 Object Dictionary Reference ..................................................................................................................... 11
1.3.3.1 Object Dictionary Object Identification ................................................................................................................ 12
1.3.3.2 Object Dictionary Interfaces................................................................................................................................. 12
1.3.3.2.1 IObjectDictionary Interface........................................................................................................................... 12
1.3.3.2.1.1 IObjectDictionary Methods .................................................................................................................... 12
1.3.3.2.1.1.1 Add Method................................................................................................................................ 12
1.3.3.2.1.1.2 AddAlias Method ........................................................................................................................ 13
1.3.3.2.1.1.3 ChangeDelGroup Method ........................................................................................................... 13
1.3.3.2.1.1.4 Find Method............................................................................................................................... 14
1.3.3.2.1.1.5 Remove Method .......................................................................................................................... 14
1.3.3.2.1.1.6 RemoveAlias Method .................................................................................................................. 15
1.3.3.2.1.1.7 RemoveDelGroup Method........................................................................................................... 15
1.3.4 Problem Determination............................................................................................................................. 15
1.3.4.1 SupplyPoints ....................................................................................................................................................... 16
2. INDEX................................................................................................................................................................. 17
1. DATA MANIPULATION
1.2.4 Troubleshooting
Data Manipulation uses the Problem Determination component to assist users in determining the cause of software
problems. The component has predefined SupplyPoints that provide trace information.
If you have problems using this component, and you want to trace the operations the component is performing, you
should use Problem Determination Analysis component and start an investigation. For information on how to initiate
investigations, and guidelines on how to interpret the information collected see the Problem Determination On-line
Documentation.
1.3 Reference
The reference section provides information on the following topics:
• Standard Data Record Reference
• Standard Data Dictionary Reference
• Object Dictionary Reference
• Problem Determination
Parameters
Name [Direction] Type Description
FieldName [in] BSTR Name of the field whose value is requested.
Return Value
FieldValue, of type VARIANT. The value of the field specified as a VARIANT.
Exceptions
None
1.3.4.1 SupplyPoints
The component for the Standard Data Dictionary, Standard Data Record and Object Dictionary provides the following
SupplyPoints:
SupplyPointHelper Function When It Is Provided
InterfaceEntry Immediately after entering the public interface functions.
InterfaceExit Immediately before leaving the public interface functions.
ImplementationEntry Immediately after entering a private method.
ImplementationExit Immediately before leaving a private method.
EventFired Immediately before raising an event.
EventArrivedEntry Immediately after an event is received.
EventArrivedExit Immediately before the event handler terminates.
General At key points in the code to provide context information, primarily for use when
collecting traces in a live environment ('tracing always on' scenario).
GeneralDebug At key points in the code to provide extra debug information, primarily for use by
development and Professional Services organisations. To be used in the following
situations:
• Assigning a value to a property
• Retrieving the value of a property
• Querying a value to be used in an expression
Warning When non-critical, unexpected issues arrive.
Exception Immediately before an exception is raised.
The SupplyPoints can be queried with MINIMUM, NORMAL or MAXIMUM content:
Content Information Provided
MINIMUM The name of the method or event associated with the SupplyPoint.
Description associated with General and GeneralDebug SupplyPoints.
Description and extended information (for example, error codes) for Warning and
Exception SupplyPoints.
NORMAL Same as MINIMUM plus name and value of simple data type in and out
parameters of methods and events.
MAXIMUM Same as MINIMUM plus name and value of all in and out parameters of methods
and events.
2. INDEX
_StandardDataRecord interface ................................. 8 ListFields method ......................................................8
Add method .............................................................12 Object Dictionary.................................................6, 11
AddAlias method .....................................................13 Object identification.............................................12
AddField method ...................................................... 9 Problem Determination ............................................15
AddRecord method ..................................................10 SupplyPoints........................................................16
ChangeDelGroup method.........................................13 RecordType property .............................................7, 8
Data dictionary.....................................................5, 10 Remove method.......................................................14
Data Manipulation .................................................... 5 RemoveAlias method...............................................15
Functional overview.............................................. 5 RemoveDelGroup method........................................15
Reference.............................................................. 6 RemoveField method .................................................9
User guide............................................................. 5 RemoveRecord method ............................................11
Data record ............................................................5, 6 Standard Data Dictionary .....................................5, 10
Find method.............................................................14 Object identification.............................................10
GetFieldValue method .............................................. 7 Standard Data Record ............................................5, 6
GetRecord method ...................................................11 Object identification...............................................6
IDataDictionary interface .........................................10 SupplyPoints for Problem Determination..................16
IDataRecord interface ............................................... 7 Troubleshooting.........................................................6
IObjectDictionary interface ......................................12