C# Class PowerStudio.DebugEngine.Breakpoint

Inheritance: IDebugBreakpointResolution2, IDebugBoundBreakpoint2, IEnumDebugBoundBreakpoints2, IDebugPendingBreakpoint2

Show file Open project: IntelliTect/PowerStudio Class Usage Examples

Public Methods

Method	Description
Bind ( ) : int	Binds this pending breakpoint to one or more code locations. When this method is called, a debug engine (DE) should attempt to bind this pending breakpoint to all code locations that match. After this method returns, the caller needs to wait for events indicating that the pending breakpoint has bound or is in error before assuming that calls to the IDebugPendingBreakpoint2::EnumBoundBreakpoints or IDebugPendingBreakpoint2::EnumErrorBreakpoints.methods will enumerate all bound or error breakpoints, respectively.
CanBind ( IEnumDebugErrorBreakpoints2 &ppErrorEnum ) : int	Determines whether this pending breakpoint can bind to a code location. This method is called to determine what would happen if this pending breakpoint was bound. Call the IDebugPendingBreakpoint2::Bind method to actually bind the pending breakpoint.
Clone ( IEnumDebugBoundBreakpoints2 &ppEnum ) : int	Returns a copy of the current enumeration as a separate object. The copy of the enumeration has the same state as the original at the time this method is called. However, the copy's and the original's states are separate and can be changed individually.
Delete ( ) : int	Deletes this pending breakpoint and all breakpoints bound from it.
Enable ( int fEnable ) : int	Toggles the enabled state of the pending breakpoint. When a pending breakpoint is enabled or disabled, all breakpoints bound from it are set to the same state. This method may be called as many times as necessary, even if the breakpoint is already enabled or disabled.
EnumBoundBreakpoints ( IEnumDebugBoundBreakpoints2 &ppEnum ) : int	Enumerates all breakpoints bound from this pending breakpoint.
EnumErrorBreakpoints ( enum_BP_ERROR_TYPE bpErrorType, IEnumDebugErrorBreakpoints2 &ppEnum ) : int	Gets a list of all error breakpoints that resulted from this pending breakpoint.
GetBreakpointRequest ( IDebugBreakpointRequest2 &ppBPRequest ) : int	Gets the breakpoint request that was used to create this pending breakpoint.
GetBreakpointResolution ( IDebugBreakpointResolution2 &ppBPResolution ) : int	Gets the pending breakpoint from which the specified bound breakpoint was created. A pending breakpoint can be thought of as a collection of all the necessary information needed to bind a breakpoint to code that can be applied to one or many programs.
GetBreakpointType ( enum_BP_TYPE pBPType ) : int	Gets the type of the breakpoint represented by this resolution. The breakpoint may be a code or a data breakpoint, for example.
GetCount ( uint &pcelt ) : int	Returns the number of elements in the enumeration. This method is not part of the customary COM enumeration interface which specifies that only the Next, Clone, Skip, and Reset methods need to be implemented.
GetHitCount ( uint &pdwHitCount ) : int	Gets the current hit count for this bound breakpoint.
GetPendingBreakpoint ( IDebugPendingBreakpoint2 &ppPendingBreakpoint ) : int	Gets the pending breakpoint from which the specified bound breakpoint was created. A pending breakpoint can be thought of as a collection of all the necessary information needed to bind a breakpoint to code that can be applied to one or many programs.
GetResolutionInfo ( enum_BPRESI_FIELDS dwFields, BP_RESOLUTION_INFO pBPResolutionInfo ) : int	Gets the breakpoint resolution information that describes this breakpoint.
GetState ( PENDING_BP_STATE_INFO pState ) : int	Gets the state of the pending breakpoint.
GetState ( enum_BP_STATE pState ) : int	Gets the state of this bound breakpoint.
Next ( uint celt, IDebugBoundBreakpoint2 rgelt, uint &pceltFetched ) : int	Returns the next set of elements from the enumeration.
Reset ( ) : int	Resets the enumeration to the first element. After this method is called, the next call to the IEnumDebugBoundBreakpoints2::Next method returns the first element of the enumeration.
SetCondition ( BP_CONDITION bpCondition ) : int	Sets or changes the condition associated with the pending breakpoint. Any condition that was previously associated with the pending breakpoint is lost. All breakpoints bound from this pending breakpoint are called to set their condition to the value specified in the bpCondition parameter.
SetHitCount ( uint dwHitCount ) : int	Sets the hit count for the bound breakpoint.
SetPassCount ( BP_PASSCOUNT bpPassCount ) : int	Sets or changes the pass count associated with the pending breakpoint. Any pass count that was previously associated with the pending breakpoint is lost. All breakpoints bound from this pending breakpoint are called to set their pass count to the bpPassCount parameter.
Skip ( uint celt ) : int	Skips over the specified number of elements. If celt specifies a value greater than the number of remaining elements, the enumeration is set to the end and S_FALSE is returned.
Virtualize ( int fVirtualize ) : int	Toggles the virtualized state of this pending breakpoint. When a pending breakpoint is virtualized, the debug engine will attempt to bind it every time new code loads into the program. A virtualized breakpoint is bound every time code is loaded.

Method Details

Bind() public method

Binds this pending breakpoint to one or more code locations.

When this method is called, a debug engine (DE) should attempt to bind this pending breakpoint to all code locations that match. After this method returns, the caller needs to wait for events indicating that the pending breakpoint has bound or is in error before assuming that calls to the IDebugPendingBreakpoint2::EnumBoundBreakpoints or IDebugPendingBreakpoint2::EnumErrorBreakpoints.methods will enumerate all bound or error breakpoints, respectively.

public Bind ( ) : int
return	int

CanBind() public method

Determines whether this pending breakpoint can bind to a code location.

This method is called to determine what would happen if this pending breakpoint was bound. Call the IDebugPendingBreakpoint2::Bind method to actually bind the pending breakpoint.

public CanBind ( IEnumDebugErrorBreakpoints2 &ppErrorEnum ) : int
ppErrorEnum	IEnumDebugErrorBreakpoints2	Returns an IEnumDebugErrorBreakpoints2 object that contains a list of IDebugErrorBreakpoint2 objects if there could be errors.
return	int

Clone() public method

Returns a copy of the current enumeration as a separate object.

The copy of the enumeration has the same state as the original at the time this method is called. However, the copy's and the original's states are separate and can be changed individually.

public Clone ( IEnumDebugBoundBreakpoints2 &ppEnum ) : int
ppEnum	IEnumDebugBoundBreakpoints2	Returns a copy of this enumeration as a separate object.
return	int

Delete() public method

Deletes this pending breakpoint and all breakpoints bound from it.

public Delete ( ) : int
return	int

Enable() public method

Toggles the enabled state of the pending breakpoint.

When a pending breakpoint is enabled or disabled, all breakpoints bound from it are set to the same state. This method may be called as many times as necessary, even if the breakpoint is already enabled or disabled.

public Enable ( int fEnable ) : int
fEnable	int	Set to nonzero (TRUE) to enable a pending breakpoint, or to zero (FALSE) to disable.
return	int

EnumBoundBreakpoints() public method

Enumerates all breakpoints bound from this pending breakpoint.

public EnumBoundBreakpoints ( IEnumDebugBoundBreakpoints2 &ppEnum ) : int
ppEnum	IEnumDebugBoundBreakpoints2	Returns an IEnumDebugBoundBreakpoints2 object that enumerates the bound breakpoints.
return	int

EnumErrorBreakpoints() public method

Gets a list of all error breakpoints that resulted from this pending breakpoint.

public EnumErrorBreakpoints ( enum_BP_ERROR_TYPE bpErrorType, IEnumDebugErrorBreakpoints2 &ppEnum ) : int
bpErrorType	enum_BP_ERROR_TYPE	A combination of values from the BP_ERROR_TYPE enumeration that selects the type of errors to enumerate.
ppEnum	IEnumDebugErrorBreakpoints2	Returns an IEnumDebugErrorBreakpoints2 object that contains a list of IDebugErrorBreakpoint2 objects.
return	int

GetBreakpointRequest() public method

Gets the breakpoint request that was used to create this pending breakpoint.

public GetBreakpointRequest ( IDebugBreakpointRequest2 &ppBPRequest ) : int
ppBPRequest	IDebugBreakpointRequest2	Returns an IDebugBreakpointRequest2 object representing the breakpoint request that was used to create this pending breakpoint.
return	int

GetBreakpointResolution() public method

Gets the pending breakpoint from which the specified bound breakpoint was created.

A pending breakpoint can be thought of as a collection of all the necessary information needed to bind a breakpoint to code that can be applied to one or many programs.

public GetBreakpointResolution ( IDebugBreakpointResolution2 &ppBPResolution ) : int
ppBPResolution	IDebugBreakpointResolution2	Returns the IDebugPendingBreakpoint2 object that represents the pending breakpoint that was used to create this bound breakpoint.
return	int

GetBreakpointType() public method

Gets the type of the breakpoint represented by this resolution.

The breakpoint may be a code or a data breakpoint, for example.

public GetBreakpointType ( enum_BP_TYPE pBPType ) : int
pBPType	enum_BP_TYPE	Returns a value from the BP_TYPE enumeration that specifies the type of this breakpoint.
return	int

GetCount() public method

Returns the number of elements in the enumeration.

This method is not part of the customary COM enumeration interface which specifies that only the Next, Clone, Skip, and Reset methods need to be implemented.

public GetCount ( uint &pcelt ) : int
pcelt	uint	Returns the number of elements in the enumeration.
return	int

GetHitCount() public method

Gets the current hit count for this bound breakpoint.

public GetHitCount ( uint &pdwHitCount ) : int
pdwHitCount	uint	Returns the hit count.
return	int

GetPendingBreakpoint() public method

Gets the pending breakpoint from which the specified bound breakpoint was created.

A pending breakpoint can be thought of as a collection of all the necessary information needed to bind a breakpoint to code that can be applied to one or many programs.

public GetPendingBreakpoint ( IDebugPendingBreakpoint2 &ppPendingBreakpoint ) : int
ppPendingBreakpoint	IDebugPendingBreakpoint2	Returns the IDebugPendingBreakpoint2 object that represents the pending breakpoint that was used to create this bound breakpoint.
return	int

GetResolutionInfo() public method

Gets the breakpoint resolution information that describes this breakpoint.

public GetResolutionInfo ( enum_BPRESI_FIELDS dwFields, BP_RESOLUTION_INFO pBPResolutionInfo ) : int
dwFields	enum_BPRESI_FIELDS	A combination of flags from the BPRESI_FIELDS enumeration that determine which fields of the pBPResolutionInfo parameter are to be filled out.
pBPResolutionInfo	BP_RESOLUTION_INFO	The BP_RESOLUTION_INFO structure to be filled in with information about this breakpoint.
return	int

GetState() public method

Gets the state of the pending breakpoint.

public GetState ( PENDING_BP_STATE_INFO pState ) : int
pState	PENDING_BP_STATE_INFO	A PENDING_BP_STATE_INFO structure that is filled in with a description of this pending breakpoint.
return	int

GetState() public method

Gets the state of this bound breakpoint.

public GetState ( enum_BP_STATE pState ) : int
pState	enum_BP_STATE	Returns a value from the BP_STATE enumeration that describes the state of the breakpoint.
return	int

Next() public method

Returns the next set of elements from the enumeration.

public Next ( uint celt, IDebugBoundBreakpoint2 rgelt, uint &pceltFetched ) : int
celt	uint	The number of elements to retrieve. Also specifies the maximum size of the rgelt array.
rgelt	IDebugBoundBreakpoint2	Array of IDebugBoundBreakpoint2 elements to be filled in.
pceltFetched	uint	Returns the number of elements actually returned in rgelt.
return	int

Reset() public method

Resets the enumeration to the first element.

After this method is called, the next call to the IEnumDebugBoundBreakpoints2::Next method returns the first element of the enumeration.

public Reset ( ) : int
return	int

SetCondition() public method

Sets or changes the condition associated with the pending breakpoint.

Any condition that was previously associated with the pending breakpoint is lost. All breakpoints bound from this pending breakpoint are called to set their condition to the value specified in the bpCondition parameter.

public SetCondition ( BP_CONDITION bpCondition ) : int
bpCondition	BP_CONDITION	A BP_CONDITION structure that specifies the condition to set.
return	int

SetHitCount() public method

Sets the hit count for the bound breakpoint.

public SetHitCount ( uint dwHitCount ) : int
dwHitCount	uint	The hit count to set.
return	int

SetPassCount() public method

Sets or changes the pass count associated with the pending breakpoint.

Any pass count that was previously associated with the pending breakpoint is lost. All breakpoints bound from this pending breakpoint are called to set their pass count to the bpPassCount parameter.

public SetPassCount ( BP_PASSCOUNT bpPassCount ) : int
bpPassCount	BP_PASSCOUNT	A BP_PASSCOUNT structure that contains the pass count.
return	int

Skip() public method

Skips over the specified number of elements.

If celt specifies a value greater than the number of remaining elements, the enumeration is set to the end and S_FALSE is returned.

public Skip ( uint celt ) : int
celt	uint	Number of elements to skip.
return	int

Virtualize() public method

Toggles the virtualized state of this pending breakpoint. When a pending breakpoint is virtualized, the debug engine will attempt to bind it every time new code loads into the program.

A virtualized breakpoint is bound every time code is loaded.

public Virtualize ( int fVirtualize ) : int
fVirtualize	int	Set to nonzero (TRUE) to virtualize the pending breakpoint, or to zero (FALSE) to turn off virtualization.
return	int