GetValues

The GetValues method gets the value of several of the target's registers.

HRESULT
  IDebugRegisters::GetValues(
    IN ULONG  Count,
    IN OPTIONAL PULONG  Indices,
    IN ULONG  Start,
    OUT PDEBUG_VALUE  Values
    );

Parameters

Count

Specifies the number of registers whose values are requested.

Indices

Specifies an array that contains the indices of the registers from which to get the values. The number of elements in this array is Count. If Indices is NULL, Start is used instead.

Start

If Indices is NULL, the registers will be read consecutively starting at this index. Otherwise it is ignored.

Values

Receives the values of the registers. The number of elements this array holds is Count. See DEBUG_VALUE for a description of this parameter type.

Return Value

S_OK

The method was successful.

E_UNEXPECTED

The target is not accessible, or one of the registers could not be accessed.

E_INVALIDARG

The value of the index of one of the registers is greater than the number of registers on the target machine. Partial results might have been obtained; those registers that could not be read will have the type DEBUG_VALUE_INVALID.

This list does not contain all the errors that might occur. For a list of possible errors, see HRESULT Values.

Interface Version

GetValues is available in all versions of IDebugRegisters.

Comments

GetValues gets the value of several of the target's registers.

If the return value is not S_OK, some of the registers still might have been read. If the target was not accessible, the return type is E_UNEXPECTED and Values is unchanged; otherwise, Values will contain partial results and the registers that could not be read will have type DEBUG_VALUE_INVALID. Ambiguity in the case of the return value E_UNEXPECTED can be avoided by setting the memory of Values to zero before calling this method.

To receive the value of only a single register, use the GetValue method instead.

The method GetValues2 performs the same task as this method but also allows the register source to be specified.

For an overview of the IDebugRegisters interface and other register-related methods, see Registers.

Requirements

Headers: Defined in DbgEng.h. Include DbgEng.h.

See Also

GetValue, GetValues2