GetSpecificFilterArgument

The GetSpecificFilterArgument and GetSpecificFilterArgumentWide methods return the value of filter argument for thespecific filters that have an argument.

HRESULT
  IDebugControl::GetSpecificFilterArgument(
    IN ULONG  Index,
    OUT OPTIONAL PSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  ArgumentSize
    );

HRESULT
  IDebugControl3::GetSpecificFilterArgumentWide(
    IN ULONG  Index,
    OUT OPTIONAL PWSTR  Buffer,
    IN ULONG  BufferSize,
    OUT OPTIONAL PULONG  ArgumentSize
    );

#ifdef UNICODE
#define GetSpecificFilterArgumentT GetSpecificFilterArgumentWide
#else
#define GetSpecificFilterArgumentT GetSpecificFilterArgument
#endif

Parameters

Index

Specifies the index of the specific filter whose argument will be returned. Index must be the index of a specific filter that has an argument.

Buffer

Receives the argument for the specific filter. The interpretation of the argument depends on the specific filter.

BufferSize

Specifies the size, in characters, of the buffer that Buffer specifies.

ArgumentSize

Receives the size, in characters, of the argument for the specific filter.

Return Value

S_OK

The method was successful.

E_INVALIDARG

Index does not refer to a specific filter that has an argument.

This method may also return error values. See Return Values for more details.

Interface Version

GetSpecificFilterArgument is available in all versions of IDebugControl. GetSpecificFilterArgumentWide is available in IDebugControl3 and later versions.

Comments

For a list of specific filters that have argument and the interpretation of those arguments, see Event Filters.

Requirements

Headers: Defined in Dbgeng.h. Include Dbgeng.h.

See Also

sx, sxd, sxe, sxi, sxn (Set Exceptions), SetSpecificFilterArgument, GetSpecificFilterParameters