IDebugControl3::GetExpressionSyntaxNames method

The GetExpressionSyntaxNames method returns the full and abbreviated names of an expression syntax.

Syntax


HRESULT GetExpressionSyntaxNames(
  [in]             ULONG Index,
  [out, optional]  PSTR FullNameBuffer,
  [in]             ULONG FullNameBufferSize,
  [out, optional]  PULONG FullNameSize,
  [out, optional]  PSTR AbbrevNameBuffer,
  [in]             ULONG AbbrevNameBufferSize,
  [out, optional]  PULONG AbbrevNameSize
);

Parameters

Index [in]

Specifies the index of the expression syntax. Index should be between zero and the number of expression syntaxes returned by GetNumberExpressionSyntaxes minus one.

FullNameBuffer [out, optional]

Receives the full name of the expression syntax. If FullNameBuffer is NULL, this information is not returned.

FullNameBufferSize [in]

Specifies the size, in characters, of the buffer FullNameBuffer.

FullNameSize [out, optional]

Receives the size, in characters, of the full name of the expression syntax. If FullNameSize is NULL, this information is not returned.

AbbrevNameBuffer [out, optional]

Receives the abbreviated name of the expression syntax. If AbbrevNameBuffer is NULL, this information is not returned.

AbbrevNameBufferSize [in]

Specifies the size, in characters, of the buffer AbbrevNameBufferSize.

AbbrevNameSize [out, optional]

Receives the size, in characters, of the abbreviated name of the expression syntax. If AbbrevNameSize is NULL, this information is not returned.

Return value

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

Return codeDescription
S_OK

The method was successful.

S_FALSE

The method was successful. However, either FullNameBufferSize or AbbrevNameBufferSize was smaller than the size of the respective expression syntax name, and the name was truncated to fit inside the buffer.

 

Remarks

Currently, there are two expression syntaxes, their full names are "Microsoft Assembler expressions" and "C++ source expressions." The corresponding abbreviated expression syntaxes are "MASM" and "C++."

Requirements

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugControl3
Evaluate
GetNumberExpressionSyntaxes
SetExpressionSyntaxByName

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft