The class Symbol works with the symbols as stored in the various active storage areas. More...

Static Public Member Functions
static string	ClassName (int iRoot)
	The method ClassName returns the name of the class containing a specified symbol. More...

static int	EnumIntegerValue (string ident)
	The EnumIntegeValue method retrieves the value associated with an integer enumeration entry defined in a library description file that has been loaded during the current translation run. The identifier of the enumeration entry must be fully qualified – i.e be of the form library.enumeration.entry, or of the form library.class.enumeration.entry. Thus for example the identifier "MSComctlLib.TreeRelationshipConstants.tvwLast" identifies an enumeration entry "tvwLast" in the enumeration "TreeRelationshipConstants" in the library "MscomctlLib". More...

static string	EnumStringValue (string enumeration, string entry)
	The method EnumStringValue returns the string value of a named entry in a named string based enumeration. More...

static void	DisplayInfo (int infValue, DisplayType dispType)
	The method DisplayInfo displays various types of information associated with a symbol. It is used primarily by methods that are auditing the content of a storage area. More...

static int	FindLibVector (string Identifier, int Project)
	The method FindLibVector determines if an identifier is a member of a component in an external library. The symbol structure generated by Visual Basic source code is a fairly straight-forward tree structure. The external libraries, however, can have very complicated structures using interrelated coclasses and interface with sometimes intertwined parent-child relationships. More...

static int	FindIdentifier (string identifier, int parent)
	The method FindIdentifier finds a qualified identifier in the symbol table beneath a specified parent or anywhere within the tree. More...

static int	FindIdentifier (string identifier)

static string	FullName (int iRoot, int context)
	The method FullName returns the fully qualified name of a symbol either as defined in the source or as written in the target. More...

static int	FullType (string typeName, ref int context, ref int migStatus, int idfStatus)
	The method FullType processes a type specification string and returns its type code and any status or context flags associated with it. This is a deprecated method that uses the tool's internal bit flag conventions. It is used to process type names as entered in interface description files. More...

static int	GetDefault (int clsRoot)
	The method GetDefault gets the root of the default component of a class. The default component is the implied referenced component referenced via singleton class reference. More...

static string	GetTemplate (string TemplateName)
	The method GetTemplate gets the template string for the specified template and current language dialog. More...

static string	NamedEntryLabel (string enumName, int iValue)
	The method NamedEntryLabel gets the name of an entry in a specified enumeration that has a specified value. More...

static string	ReferenceName (string refName)
	The method ReferenceName gets the actual name of an external reference library based on its name in the source vbp file. More...

static void	Rename (string newName, int iRoot)
	The method Rename renames a symbol for use by the target. This involves either changing its name property in its storage table or changing its pattern in its structure table. More...

static int	StorePattern (string allPattern, int parameters)
	The method StorePattern stores a surface pattern along with the number of parameters that pattern uses from the string stack in the current storage area. More...

static string	SurfacePattern (tCodeBlock codptr, int icode, int idPattern, byte[] info)

static bool	Unused (int iRoot)
	The method Unused determines whether a specified symbol is used within a compiled code base. More...

static string	UseTemplate (string template, string identifier)
	The method UseTemplate retrieves a specified template and evaluates its output string using a specified identifier. More...

static void	NamedFlags (string enumName, int flags, string separate)
	The NamedFlags method writes enumeration entry binary flags for named enumerations in the language file. This method is deprecated and is present only for compatiblity with the scripting language supported by the tool which uses binary bit masks to set and get boolean properties. More...

Detailed Description

The class Symbol works with the symbols as stored in the various active storage areas.

Member Function Documentation

◆ ClassName()

static string gmslLibrary.Services.Symbol.ClassName ( int iRoot )

static

The method ClassName returns the name of the class containing a specified symbol.

Parameters

iRoot specifies the root offset of the symbol.

Returns: returns the name of the class that contains a symbol.

◆ DisplayInfo()

static void gmslLibrary.Services.Symbol.DisplayInfo	(	int	infValue,
		DisplayType	dispType
	)

static

The method DisplayInfo displays various types of information associated with a symbol. It is used primarily by methods that are auditing the content of a storage area.

Parameters

infValue	specifies one of these simple integer values whose display form is specified.
dispType	specifies the type of display information whose values are as listed in the DisplayType enumeration.

◆ EnumIntegerValue()

static int gmslLibrary.Services.Symbol.EnumIntegerValue ( string ident )

static

The EnumIntegeValue method retrieves the value associated with an integer enumeration entry defined in a library description file that has been loaded during the current translation run. The identifier of the enumeration entry must be fully qualified – i.e be of the form library.enumeration.entry, or of the form library.class.enumeration.entry. Thus for example the identifier "MSComctlLib.TreeRelationshipConstants.tvwLast" identifies an enumeration entry "tvwLast" in the enumeration "TreeRelationshipConstants" in the library "MscomctlLib".

Parameters

ident The ident parameter is the fully qualified identifier of the integer enumeration entry whose value is needed.

Returns: If the identifier does represent an integer enumeration entry within a currently loaded library description file, then its value is returned. Otherwise, the integer constant Defines.NO_VALUE_FOUND is returned.

◆ EnumStringValue()

static string gmslLibrary.Services.Symbol.EnumStringValue	(	string	enumeration,
		string	entry
	)

static

The method EnumStringValue returns the string value of a named entry in a named string based enumeration.

Parameters

enumeration	contains the name of the enumeration in the language storage area.
entry	contains the name of the particular entry whose string value is needed.

Returns: returns the named entry or an empty string if it cannot be located.

◆ FindIdentifier()

static int gmslLibrary.Services.Symbol.FindIdentifier	(	string	identifier,
		int	parent
	)

static

The method FindIdentifier finds a qualified identifier in the symbol table beneath a specified parent or anywhere within the tree.

Parameters

identifier	contains the fully qualified identifier of the desired symbol
parent	specifies the root address of the symbol tree branch to be searched or zero if the entire tree is to be searched.

Returns: The method returns the root address in storage of the identified symbol or zero if no corresponding symbol can be located.

◆ FindLibVector()

static int gmslLibrary.Services.Symbol.FindLibVector	(	string	Identifier,
		int	Project
	)

static

The method FindLibVector determines if an identifier is a member of a component in an external library. The symbol structure generated by Visual Basic source code is a fairly straight-forward tree structure. The external libraries, however, can have very complicated structures using interrelated coclasses and interface with sometimes intertwined parent-child relationships.

Parameters

Identifier	This parameter contains the identifier of the component being sought.
Parent	This method searches an external library component whose root offset is specified via the integer parameter parent to determine if it has the named member.

Returns: If the member is present in the external library, it returns the root offset of that member. If not, it returns 0.

◆ FullName()

static string gmslLibrary.Services.Symbol.FullName	(	int	iRoot,
		int	context
	)

static

The method FullName returns the fully qualified name of a symbol either as defined in the source or as written in the target.

Parameters

iRoot	specifies the root address of the symbol in the current storage area.
context	specifies the context of the symbol use. If it is non-zero then the symbol is being used within an audit report; thus, its target language names are used. If it is zero, then the source language names are used. It is this source language form that can be passed to the method Symbol_FindIdentifier to locate the symbol.

Returns: returns the fully qualified name of the symbol

◆ FullType()

static int gmslLibrary.Services.Symbol.FullType	(	string	typeName,
		ref int	context,
		ref int	migStatus,
		int	idfStatus
	)

static

The method FullType processes a type specification string and returns its type code and any status or context flags associated with it. This is a deprecated method that uses the tool's internal bit flag conventions. It is used to process type names as entered in interface description files.

Parameters

typeName	contains a fully specified type name which might include brackets to indicate its dimensionality.
context	returns the type's internal context flags.
migStatus	returns the type's internal migration status flags.
idfStatus	specifies the status of the interface description file containing the type string. At this level it should be set to zero.

Returns: The method returns the type value code for the string.

◆ GetDefault()

static int gmslLibrary.Services.Symbol.GetDefault ( int clsRoot )

static

The method GetDefault gets the root of the default component of a class. The default component is the implied referenced component referenced via singleton class reference.

Parameters

clsRoot specifies the offset of the library class or coclass.

Returns: If the specified component is of the wrong object type or if it has no default component, a zero is returned.

◆ GetTemplate()

static string gmslLibrary.Services.Symbol.GetTemplate ( string TemplateName )

static

The method GetTemplate gets the template string for the specified template and current language dialog.

Parameters

TemplateName contains the name of the property of the class Basic.Templates in the language file.

Returns: If there is no such property or if the property has no surface patterns, then an empty string is returned.

◆ NamedEntryLabel()

static string gmslLibrary.Services.Symbol.NamedEntryLabel	(	string	enumName,
		int	iValue
	)

static

The method NamedEntryLabel gets the name of an entry in a specified enumeration that has a specified value.

Parameters

enumName	contains the name of enumeration.
iValue	specifies the entry value for which an entry is desired.

Returns: If an entry exists in the enumeration with the specified value, then the name of that entry is returned and the parameter If no entry with the value exists, then an empty string is returned.

◆ NamedFlags()

static void gmslLibrary.Services.Symbol.NamedFlags	(	string	enumName,
		int	flags,
		string	separate
	)

static

The NamedFlags method writes enumeration entry binary flags for named enumerations in the language file. This method is deprecated and is present only for compatiblity with the scripting language supported by the tool which uses binary bit masks to set and get boolean properties.

Parameters

enumName	contains the name of the enumeration classifying the bit values.
flags	specifies the entry values as a sequence of binary ones and zeros.
separate	contains the separation string to be used between multiple entries. Typical setting might be " \| " or ", ".

◆ ReferenceName()

static string gmslLibrary.Services.Symbol.ReferenceName ( string refName )

static

The method ReferenceName gets the actual name of an external reference library based on its name in the source vbp file.

Parameters

refName The name as extracted from the "Reference=" entry in a vbp file.

Returns: The method returns the external name as extracted from the name in the reference.

◆ Rename()

static void gmslLibrary.Services.Symbol.Rename	(	string	newName,
		int	iRoot
	)

static

The method Rename renames a symbol for use by the target. This involves either changing its name property in its storage table or changing its pattern in its structure table.

Parameters

newName	contains the name to be used.
iRoot	specifies the root offset of the symbol to be renamed.

◆ StorePattern()

static int gmslLibrary.Services.Symbol.StorePattern	(	string	allPattern,
		int	parameters
	)

static

The method StorePattern stores a surface pattern along with the number of parameters that pattern uses from the string stack in the current storage area.

Parameters

allPattern	The parameter allPattern is the pattern string itself. Note that this method does not support multiple dialects as it is assumed that the dialect will be known at the time that the gmSL procedure performing this operation is executed.
parameters	The parameter parameters specifies the number of parameters to be associated with the pattern string.

Returns: The method returns the root offset in the current storage area of the pattern.

◆ Unused()

static bool gmslLibrary.Services.Symbol.Unused ( int iRoot )

static

The method Unused determines whether a specified symbol is used within a compiled code base.

Parameters

iRoot

Returns: If there are no references to the symbol in the executable code, the method returns true; else it reurns false.

◆ UseTemplate()

static string gmslLibrary.Services.Symbol.UseTemplate	(	string	template,
		string	identifier
	)

static

The method UseTemplate retrieves a specified template and evaluates its output string using a specified identifier.

Parameters

template	contains the name of the Templates property whose pattern string is to be used.
identifier	contains the identifier to be used as the argument for the pattern string. It may be empty, if the pattern does not have any parameters.

Returns: returns the output string.

The documentation for this class was generated from the following file:

C:/gmProducts/gmStudio_dev/src/gmslAPI/gmslLibrary/Symbol.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ClassName()

◆ DisplayInfo()

◆ EnumIntegerValue()

◆ EnumStringValue()

◆ FindIdentifier()

◆ FindLibVector()

◆ FullName()

◆ FullType()

◆ GetDefault()

◆ GetTemplate()

◆ NamedEntryLabel()

◆ NamedFlags()

◆ ReferenceName()

◆ Rename()

◆ StorePattern()

◆ Unused()

◆ UseTemplate()