IDebugControl3::GetExpressionSyntaxNames method (dbgeng.h)

Article
02/07/2022

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

[in] Index

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

[out, optional] FullNameBuffer

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

[in] FullNameBufferSize

Specifies the size, in characters, of the buffer FullNameBuffer. This size includes the space for the '\0' terminating character.

[out, optional] FullNameSize

Receives the size, in characters, of the full name of the expression syntax. This size includes the space for the '\0' terminating character. If FullNameSize is NULL, this information is not returned.

[out, optional] AbbrevNameBuffer

Receives the abbreviated name of the expression syntax. This size includes the space for the '\0' terminating character. If AbbrevNameBuffer is NULL, this information is not returned.

[in] AbbrevNameBufferSize

Specifies the size, in characters, of the buffer AbbrevNameBufferSize. This size includes the space for the '\0' terminating character.

[out, optional] AbbrevNameSize

Receives the size, in characters, of the abbreviated name of the expression syntax. This size includes the space for the '\0' terminating character. 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 code	Description
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

Requirement	Value
Target Platform	Desktop
Header	dbgeng.h (include Dbgeng.h)