gmscSymbolClass

The Symbol Service Class

The service class Symbol

The field Symbol_BitMask32

Prototype

 int Symbol_BitMask32[31]

The Symbol_BitMask32 field contains bit mask values for extracting flags from attribute values.

The field Symbol_OpcodeEnum

Prototype

 int Symbol_OpcodeEnum

The Symbol_OcodeEnum field contains the offset of an enumeration in a user storage migClass called opcode that contains surface pattern replacements for operation codes. As an example

 <Refactor>
 <Migclass id="CodeChanges">
    <Enumeration id="opcodes">
       <Entry id="Vb7ComboBox" opcode="TYP.ComboBox" nPram="0" role="control"
              cshPattern="VB7Support.ComboBox"/>
    </Enumeration>
 </Migclass>
 </Refactor>

might be placed in a translation script to replace the target declaration of ComboBoxes.

The method Symbol_ClassName

Prototype

 char* Symbol_ClassName(int objRoot,int* nIdent)

The Symbol_ClassName method returns the name of the class that contains a symbol. Its parameters are:

Parameter	Description
objRoot	specifies the root offset of the symbol.
nIdent	returns the length of the name.

The method Symbol_ClassRelationship

Prototype

 int Symbol_ClassRelationship(int leftClass,int rightClass)

The Symbol_ClassRelationship method is used when the instance of a class whose instance is being assigned, passed or used by a instance of another class. Its parameters are:

Parameter	Description
leftClass	specifies the root offset of the class receiving the instance of a another class.
rightClass	specifies the root offset of the class whose instance is being sent.

This method returns a zero, if the two classes are simply unrelated. It returns a minus one if the classes are related and no boxing operation is needed to confirm the operation. It returns a plus one if the classes are related, but a boxing operation is needed to confirm the operation.

The method Symbol_CompareSignatures

Prototype

 int Symbol_CompareSignatures(int root1,int root2)

The Symbol_CompareSignatures method Its parameters are:

Parameter	Description

The method Symbol_DeclareLibraryIdent

Prototype

 void Symbol_DeclareLibraryIdent(int libType,int levels)

The Symbol_DeclareLibraryIdent method Its parameters are:

Parameter	Description

The method Symbol_Dimensions

Prototype

 int Symbol_Dimensions(int objRoot)

The Symbol_Dimensions method Its parameters are:

Parameter	Description

The method Symbol_DisplayDeclaration

Prototype

 void Symbol_DisplayDeclaration(int iRoot)

The Symbol_DisplayDeclaration method Its parameters are:

Parameter	Description

The method Symbol_DisplayInfo

Prototype

 void Symbol_DisplayInfo(int infValue,int dispType)

The Symbol_DisplayInfo method Its parameters are:

Parameter	Description

The method Symbol_DisplayLineContent

Prototype

 void Symbol_DisplayLineContent(int lineNo,int iRoot)

The Symbol_DisplayLineContent method Its parameters are:

Parameter	Description

The method Symbol_DisplayLineNumber

Prototype

 void Symbol_DisplayLineNumber(int lineNo,int iRoot)

The Symbol_DisplayLineNumber method Its parameters are:

Parameter	Description

The method Symbol_DisplayPathname

Prototype

 void Symbol_DisplayPathname(int iRoot)

The Symbol_DisplayPathname method Its parameters are:

Parameter	Description

The method Symbol_DisplayObjectType

Prototype

 void Symbol_DisplayObjectType(int iRoot)

The Symbol_DisplayObjectType method Its parameters are:

Parameter	Description

The method Symbol_DisplayReference

Prototype

 void Symbol_DisplayReference(int iRoot)

The Symbol_DisplayReference method Its parameters are:

Parameter	Description

The method Symbol_EnumSetNamedFlags

Prototype

 int  Symbol_EnumSetNamedFlags(CONST char* enumName,char* flagSettings,int flags)

The Symbol_EnumSetNamedFlags method Its parameters are:

Parameter	Description

The method Symbol_EnumStringValue

Prototype

 char* Symbol_EnumStringValue(CONST char* enumName,char* entryName,int nName,int* nString)

The Symbol_EnumStringValue method Its parameters are:

Parameter	Description

The method Symbol_FindAllRoots

Prototype

 int Symbol_FindAllRoots(char* identifier,int parent,int* children,int maxChild,int CaseSensitive)

The Symbol_FindFindAllRoots method returns the root offsets of all symbols whose identifier matches a specified one and that optionally have a specified parent. The criteria for the identifier match may or may not be case sensitive. Its parameters are:

Parameter	Description
identifier	contains the identifier whose root offsets are to be returned.
parent	specifies the parent hosting the identified symbols. If zero then all identified symbols are returned. If no zero then only those symbols with that parent in their branch of the hierarchical tree are reurned.
children	returns the root offsets of symbols that match the criteria of the search.
maxChild	specifies the maximum number of root offsets to be returned. Once this number have been retrieved, the search ends.
CaseSensitive	specifies whether the identifier match should be case sensitive. A nonzero value adds this additional case sensitive comparison to the offsets returned by the method Store_GetSymbols.

The method returns the number of symbols found with the specified identifier and parent. It will always be a value between zero and maxChild.

The method Symbol_FindEnumEntryByValue

Prototype

 int Symbol_FindEnumEntryByValue(int enumRoot,int iValue)

The Symbol_FindEnumEntryByValue method Its parameters are:

Parameter	Description

The method Symbol_FindEnumEntryByName

Prototype

 int Symbol_FindEnumEntryByName(CONST char* enumName,CONST char* entryName,int nName)

The Symbol_FindEnumEntryByName method Its parameters are:

Parameter	Description

The method Symbol_FindEnumNamedIndex

Prototype

 int Symbol_FindEnumNamedIndex(CONST char* enumName,CONST char* entryName,int nName)

The Symbol_FindEnumNamedIndex method Its parameters are:

Parameter	Description

The method Symbol_FindIdentifier

Prototype

 int Symbol_FindIdentifier(char* identifier,int parent)

The Symbol_FindIdentifier method Its parameters are:

Parameter	Description

The method Symbol_FindLibComponent

Prototype

 int Symbol_FindLibComponent(char* ident,int parent,int refType)

The Symbol_FindLibComponent method Its parameters are:

Parameter	Description

The method Symbol_FindLibVector

Prototype

 int Symbol_FindLibVector(CONST char* ident,int parent)

The Symbol_FindLibVector method Its parameters are:

Parameter	Description

The method Symbol_FullName

Prototype

 int Symbol_FullName(char* FullName,int iRoot,int context)

The Symbol_FullName method Its parameters are:

Parameter	Description

The method Symbol_GetDefault

Prototype

 int Symbol_GetDefault(int clsRoot)

The Symbol_GetDefault method Its parameters are:

Parameter	Description

The method Symbol_GetBinaryType

Prototype

 int Symbol_GetBinaryType(int propType)

The Symbol_GetBinaryType method Its parameters are:

Parameter	Description

The method Symbol_GetFullBinaryType

Prototype

 int Symbol_GetFullBinaryType(int propType,int* context)

The Symbol_GetFullBinaryType method Its parameters are:

Parameter	Description

The method Symbol_GetMigrationStatus

Prototype

 int Symbol_GetMigrationStatus(int iComp)

The Symbol_GetMigrationStatus method Its parameters are:

Parameter	Description

The method Symbol_GetObjectType

Prototype

 int Symbol_GetObjectType(int propType)

The Symbol_GetObjectType method Its parameters are:

Parameter	Description

The method Symbol_GetRoleOfType

Prototype

 int Symbol_GetRoleOfType(int qeType,int* defaultProperty)

The Symbol_GetRoleOfType method Its parameters are:

Parameter	Description

The method Symbol_GetRoleStatus

Prototype

 int Symbol_GetRoleStatus(int objRoot,int* status)

The Symbol_GetRoleStatus method Its parameters are:

Parameter	Description

The method Symbol_GetSurfaceIdent

Prototype

 char* Symbol_GetSurfaceIdent(int root,int* nIdent)

The Symbol_GetSurfaceIdent method Its parameters are:

Parameter	Description

The method Symbol_GetTemplate

Prototype

 char* Symbol_GetTemplate(CONST char* templateStr,int* nString)

The Symbol_GetTemplate method Its parameters are:

Parameter	Description

The method Symbol_NamedFlagsToString

Prototype

 int Symbol_NamedFlagsToString(char* buffer,char* enumName,int flags,char* separate)

The Symbol_NamedFlagsToString method Its parameters are:

Parameter	Description

The method Symbol_NamedEntryLabel

Prototype

 char* Symbol_NamedEntryLabel(CONST char* enumName,int iValue,int* nIdent)

The Symbol_NamedEntryLabel method Its parameters are:

Parameter	Description

The method Symbol_ObjectPattern

Prototype

 int Symbol_ObjectPattern(int symRoot,int idPattern)

The Symbol_ObjectPattern method Its parameters are:

Parameter	Description

The method Symbol_Rename

Prototype

 void Symbol_Rename(char* name,int iRoot,int nName)

The Symbol_Rename method Its parameters are:

Parameter	Description

The method Symbol_SetOverload

Prototype

 void Symbol_SetOverload(int subRoot)

The Symbol_SetOverload method Its parameters are:

Parameter	Description

The method Symbol_SetPatternArgs

Prototype

 void Symbol_SetPatternArgs(UBYTE* Pattern, int nArg)

The Symbol_SetPatternArgs method Its parameters are:

Parameter	Description

The method Symbol_StorePattern

Prototype

 int Symbol_StorePattern(UBYTE* Pattern, char* allPattern,char* cshPattern,char* vbnPattern, char* Parameters,char* Role,char* Status)

The Symbol_StorePattern method Its parameters are:

Parameter	Description

The method Symbol_SurfacePattern

Prototype

 UBYTE* Symbol_SurfacePattern(UBYTE* pcode,int* dialect,int idPattern)

The Symbol_SurfacePattern method Its parameters are:

Parameter	Description

The method Symbol_UseTemplate

Prototype

 int Symbol_UseTemplate(CONST char* templateStr,char* ident,int nIdent,char* buffer)

The Symbol_UseTemplate method Its parameters are:

Parameter	Description

The method Symbol_ValueParameter

Prototype

 int Symbol_ValueParameter(int subRoot)

The Symbol_ValueParameter method Its parameters are:

Parameter	Description

The method Symbol_WriteBinaryType

Prototype

 void Symbol_WriteBinaryType(int binaryType)

The Symbol_WriteBinaryType method Its parameters are:

Parameter	Description

The method Symbol_WriteNamedFlags

Prototype

 void Symbol_WriteNamedFlags(char* enumName,int flags,char* separate)

The Symbol_WriteNamedFlags method Its parameters are:

Parameter	Description

The method Symbol_WriteObjectType

Prototype

 void Symbol_WriteObjectType(int objType,int iRoot)

The Symbol_WriteObjectType method Its parameters are:

Parameter	Description