FUNCTION xpxDefineMethodSignature (methodType, methodName  : STRING;
                                   schemaName, methodClass : STRING;
                                   argumentNames           : LIST OF STRING; 
                                   argumentDataTypes       : LIST OF INTEGER;
                                   description             : STRING)   
                                   status                  : INTEGER;

This function provides additional information / documentation of methods in the EDMdatabase. The purpose of the user defined method signatures is to provide information about the methods and their input parameters to the users. The methods in question are Express-X mapping schemas and query functions. Query functions already have their input parameters stored in the dictionary model. Therefore, this function si not applicable for query function methods. However, there is no accompanying information that describes each input parameter nor the purpose of the method it self. Use xpxModifyMethodSignature to add this information. For mapping schemas, there is no information about the required input parameters in the dictionary model at all. By manually adding this information, users may find the required documentation of the methods within the EDMdatabase One mapping schema may be used for many methods. I.e, they may all be based on the same piece of Express-X code, but the behavior may depend on the input parameter signature given.

Arguments

1	Type	Name	Comment
2	STRING	methodType	Specify type of method, XPX or QEX
3	STRING	methodName	Specify name of method
4	STRING	schemaName	SchemaMap, ExpressSchema or QuerySchema name
5	STRING	methodClass	optional: Examples: ifc_checkin, ifc_checkout, ifc_heal
6	LIST OF STRING	argumentNames	NULL terminated list of argument names
7	LIST OF INTEGER	argumentDataTypes	List of parameter data types
8	STRING	description	Optional. User added information/documentation, explaining the purpose of the method

Return Value

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

Options

Example

<Missing Example>

Arguments

Return Value

Options

Example

See also

Filter by label