GetProcessorTypeNames

The GetProcessorTypeNames and GetProcessorTypeNamesWide methods return the full name and abbreviated name of the specified processor type.

HRESULT
  IDebugControl::GetProcessorTypeNames(
    IN ULONG  Type,
    OUT OPTIONAL PSTR  FullNameBuffer,
    IN ULONG  FullNameBufferSize,
    OUT OPTIONAL PULONG  FullNameSize,
    OUT OPTIONAL PSTR  AbbrevNameBuffer,
    IN ULONG  AbbrevNameBufferSize,
    OUT OPTIONAL PULONG  AbbrevNameSize
    );

HRESULT
  IDebugControl4::GetProcessorTypeNamesWide(
    IN ULONG  Type,
    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 GetProcessorTypeNamesT GetProcessorTypeNamesWide
#else
#define GetProcessorTypeNamesT GetProcessorTypeNames
#endif

Parameters

Type

Specifies the type of the processor whose name is requested. See GetActualProcessorType for a list of possible values.

FullNameBuffer

Receives the full name of the processor type. If FullNameBuffer is NULL, this information is not returned.

FullNameBufferSize

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

FullNameSize

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

AbbrevNameBuffer

Receives the abbreviated name of the processor type. If AbbrevNameBuffer is NULL, this information is not returned.

AbbrevNameBufferSize

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

AbbrevNameSize

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

Return Value

S_OK

The method was successful.

S_FALSE

The method was successful. However, at least one of FullNameBuffer or AbbrevNameBuffer was too small for the corresponding name, so the name was truncated.

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

Interface Version

GetProcessorTypeNames is available in all versions of IDebugControl. GetProcessorTypeNamesWide is available in IDebugControl4 and later versions.

Comments

For more information, see Target Information.

Requirements

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

See Also

GetSupportedProcessorTypes