Source Code Generated by BladeSmith

BladeSmith generates the following source code for each client and server project:

• Makefiles, project files, header files, definitions files, and so on, for both the client project and the server project
• A support library for use by the client and server projects

• Interfaces to the object for use by the client application developer
• C++ common code that provides the internal logic for both the client and server projects
• Server project opaque type support routines not available as ActiveX custom methods, and other code for use by the Informix database server

• Comments. BladeSmith includes comments to the developer regarding which sections must or may be modified; for more information, see "Adding Project-Specific Logic to the Source Code".
• MI_FPARAM argument. This is not included in C++ code; it is a C language argument.
• Server connection handle. This handle is not needed for C++ code.
• Tracing. BladeSmith does not insert tracing logic into the generated C++ code. However, you can use the DataBlade API tracing macros in your server code; see "Tracing and Error Handling" for instructions.
• Error handling. BladeSmith inserts the DkErrorRaise( ) method into the generated routines to which you must add project-specific logic, naming the routine that has not been implemented and the file in which it resides (see "Adding Project-Specific Logic to the Source Code"). You can add DkErrorRaise( ) to other areas of the generated code and to your project-specific logic as appropriate. For information on the DkErrorRaise( ) object method, see "Internal Object Methods".
• Utility functions. BladeSmith generates a C++ support library for each client and server project, and uses the routines and methods of the library in its generated code. For information on this support library, see "C++ Support Library".

• The function definition and a function body that contains only a call to DkErrorRaise(). These routines are indicated by the comment Developer: TO DO.

BladeSmith inserts the DkErrorRaise() method into these routines, naming the routine that has not been implemented and the file in which it resides. When you supply the logic to these routines, you can remove the call to DkErrorRaise() or modify it to return an error more appropriate to the added logic. (For information on the DkErrorRaise() object method, see "Internal Object Methods".)

• The function definition and a default function body. These routines are indicated by the comment Developer: Make changes in this section if necessary.

Add your project-specific logic to the following files, where Opaque is the name of the opaque type you defined:

OpaqueCommon.cpp	Contains the logic for the opaque type routines that are implemented both as ActiveX custom methods and server project routines.
OpaqueCommon.h	Contains the logic for the IsNull() and SetNullFlag() custom methods.
OpaqueServer.cpp	Contains the logic for the opaque type routines that are implemented only for the server project.

Important: In addition to adding logic to the opaque support routines, you can add your own functions to the C++ classes in the OpaqueCommon, OpaqueClient, and OpaqueServer .cpp and .h files. Do not modify any other of the generated source files.

The rest of this section contains programming guidelines for editing the source code, and then lists the routines to edit.

Programming Guidelines

• Use the following sets of methods in your code to ensure that your code is portable between the client and server projects:
  • The object methods that are made available as ActiveX custom methods; see "Adding Project-Specific Logic to the Source Code"
  • The internal object methods that are not made available as ActiveX custom methods; see "Internal Object Methods"
  • The generated C++ support library; see "C++ Support Library"

For additional functionality, use the DataBlade API. For information, see the DataBlade API Programmer's Manual.

• In the server project, use C++ only to implement the opaque type support routines that you intend to encapsulate as ActiveX value objects. Do not use C++ to implement any other DataBlade module objects.
• Do not use the INFORMIX-Object Interface for C++ in server project code.
• Do not change the function headers or parameter lists of any of the support routines for the opaque type.
• Do not use virtual methods or virtual base classes (either direct or inherited).
• In the server project, check for routine arguments with null values. The server will not call a routine that has an argument with a null value.
• In the client project, if your project does not need to handle null values, you can remove all calls to IsNull(), SetNull(), and SetNullFlag() in the generated code. Then make sure all constructor functions call SetNotNull().

For information on the usual behavior of the ActiveX custom methods (those defined in the OpaqueCommon.cpp and OpaqueCommon.h files), see Chapter 7, "Using ActiveX Value Objects." For information on the default behavior of the server project routines, see "Code Generated for Opaque Type Support Routines".

(1 of 3)

Routine Category	Opaque Type Routine/ ActiveX Custom Method	Source File	Add Logic? (Optional/Required)
Basic Text Input/Output	FromString() ToString()	OpaqueCommon.cpp	Optional Optional
Binary Send/Receive With Client	Send() Receive()	OpaqueServer.cpp	Optional Optional
Text File Import/Export	ImportText() ExportText()	OpaqueServer.cpp	Optional Optional
Binary File Import/Export	ImportBinary() ExportBinary()	OpaqueServer.cpp	Optional Optional
Type Compare Support	Compare() Equal()* NotEqual()	OpaqueCommon.cpp	Optional Optional Optional
B-Tree Indexing Support	Equal()* GreaterThan() GreaterThanOrEqual() LessThan() LessThanOrEqual()	OpaqueCommon.cpp	Optional Optional Optional Optional Optional
R-Tree Indexing Support	Equal()* Contains() Inter() Overlap() Size() Union() Within()	OpaqueCommon.cpp	Optional Optional Required Optional Required Required Optional
Type Mathematic Operators	Plus() Minus() Times() Divide()	OpaqueCommon.cpp	Required Required Required Required
More Mathematic Operators	Positive() Negate()	OpaqueCommon.cpp	Required Required
Type Concatenation Operator	Concat()	OpaqueCommon.cpp	Required
Type Hash Support	Hash()	OpaqueServer.cpp	Required