C# Class PowerStudio.DebugEngine.DebugModuleBase

Inheritance: IDebugModule3

Show file Open project: IntelliTect/PowerStudio Class Usage Examples

Public Methods

Method	Description
GetInfo ( enum_MODULE_INFO_FIELDS dwFields, MODULE_INFO pinfo ) : int	Gets information about this module. The MODULE_INFO structure contains the name of the module that is displayed in the Modules window.
GetSymbolInfo ( enum_SYMBOL_SEARCH_INFO_FIELDS dwFields, MODULE_SYMBOL_SEARCH_INFO pinfo ) : int	Retrieves a list of paths that are searched for symbols as well as the results of searching each path. If the bstrVerboseSearchInfo field of the MODULE_SYMBOL_SEARCH_INFO structure is not empty, then it contains a list of paths searched and the results of that search. The list is formatted with a path, followed by ellipses ("..."), followed by the result. If there is more than one path result pair, then each pair is separated by a "\r\n" (carriage-return/linefeed) pair. The pattern looks like this: `{path}...{result}\r\n{path}...{result}\r\n{path}...{result}` Note that the last entry does not have a \r\n sequence.
IsUserCode ( int &pfUser ) : int	Retrieves information on whether the module represents user code or not.
LoadSymbols ( ) : int	Loads the symbols for the current module. This method loads the symbols from the current search path (which can be altered by calling the IDebugEngine3::SetSymbolPath method). This method is preferred over the IDebugModule2::ReloadSymbols_Deprecated method.
SetJustMyCodeState ( int fIsUserCode ) : int	Marks the module as being user code or not.

Private Methods

Method	Description
ReloadSymbols_Deprecated ( string pszUrlToSymbols, string &pbstrDebugMessage ) : int

Method Details

GetInfo() public method

Gets information about this module.

The MODULE_INFO structure contains the name of the module that is displayed in the Modules window.

public GetInfo ( enum_MODULE_INFO_FIELDS dwFields, MODULE_INFO pinfo ) : int
dwFields	enum_MODULE_INFO_FIELDS	A combination of flags from the MODULE_INFO_FIELDS enumeration that specify which fields of pInfo are to be filled out.
pinfo	MODULE_INFO	A MODULE_INFO structure that is filled in with a description of the module.
return	int

GetSymbolInfo() public method

Retrieves a list of paths that are searched for symbols as well as the results of searching each path.

If the bstrVerboseSearchInfo field of the MODULE_SYMBOL_SEARCH_INFO structure is not empty, then it contains a list of paths searched and the results of that search. The list is formatted with a path, followed by ellipses ("..."), followed by the result. If there is more than one path result pair, then each pair is separated by a "\r\n" (carriage-return/linefeed) pair. The pattern looks like this: {path}...{result}\r\n{path}...{result}\r\n{path}...{result} Note that the last entry does not have a \r\n sequence.

public GetSymbolInfo ( enum_SYMBOL_SEARCH_INFO_FIELDS dwFields, MODULE_SYMBOL_SEARCH_INFO pinfo ) : int
dwFields	enum_SYMBOL_SEARCH_INFO_FIELDS	A combination of flags from the SYMBOL_SEARCH_INFO_FIELDS enumeration specifying which fields of pInfo are to be filled in.
pinfo	MODULE_SYMBOL_SEARCH_INFO	A MODULE_SYMBOL_SEARCH_INFO structure whose members are to be filled in with the specified information. If this is a null value, this method returns E_INVALIDARG.
return	int

IsUserCode() public method

Retrieves information on whether the module represents user code or not.

public IsUserCode ( int &pfUser ) : int
pfUser	int	Nonzero (TRUE) if module represents user code, zero (FALSE) if it does not.
return	int

LoadSymbols() public method

Loads the symbols for the current module.

This method loads the symbols from the current search path (which can be altered by calling the IDebugEngine3::SetSymbolPath method). This method is preferred over the IDebugModule2::ReloadSymbols_Deprecated method.

public LoadSymbols ( ) : int
return	int

SetJustMyCodeState() public method

Marks the module as being user code or not.

public SetJustMyCodeState ( int fIsUserCode ) : int
fIsUserCode	int	Nonzero (TRUE) if the module should be considered user code, zero (FALSE) if it should not.
return	int