GetExpressionSyntaxNames

The GetExpressionSyntaxNames and GetExpressionSyntaxNamesWide methods return the full and abbreviated names of an expression syntax.

HRESULT
  IDebugControl3::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
    );

HRESULT
  IDebugControl4::GetExpressionSyntaxNamesWide(
    IN ULONG  Index,
    OUT OPTIONAL PWSTR  FullNameBuffer,
    IN ULONG  FullNameBufferSize,
    OUT OPTIONAL PULONG  FullNameSize,
    OUT OPTIONAL PWSTR  AbbrevNameBuffer,
    IN ULONG  AbbrevNameBufferSize,
    OUT OPTIONAL PULONG  AbbrevNameSize
    );

#ifdef UNICODE
#define GetExpressionSyntaxNamesT GetExpressionSyntaxNamesWide
#else
#define GetExpressionSyntaxNamesT GetExpressionSyntaxNames
#endif

Parameters

Index

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

FullNameBuffer

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

FullNameBufferSize

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

FullNameSize

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

AbbrevNameBuffer

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

AbbrevNameBufferSize

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

AbbrevNameSize

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

Return Value

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.

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

Interface Version

GetExpressionSyntaxNames is available in IDebugControl3 and later versions. GetExpressionSyntaxNamesWide is available in IDebugControl4 and later versions.

Comments

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

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

See Also

Evaluate, GetNumberExpressionSyntaxes, SetExpressionSyntaxByName