IDebugControl4::GetSystemVersionString method (dbgeng.h)

Article
02/22/2024

The GetSystemVersionString method returns a string that describes the target's operating system version.

Syntax

HRESULT GetSystemVersionString(
  [in]            ULONG  Which,
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG StringSize
);

Parameters

[in] Which

Specifies which version string to return. The possible values are listed in the following table.

Value	Version string
DEBUG_SYSVERSTR_SERVICE_PACK	Returns a description of the service pack for the target's operating system. For example, "Service Pack 1".
DEBUG_SYSVERSTR_BUILD	Returns a description of the target's operating system build version. For example, "kernel32.dll version: 5.1.2600.1106 (xpsp1.020828-1920)".

[out, optional] Buffer

Receives the version string. If Buffer is NULL, this information is not returned.

[in] BufferSize

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

[out, optional] StringSize

Receives the size, in characters, of the string that identifies the build. This size includes the space for the '\0' terminating character. If SizeString is NULL, this information is not returned.

Return value

This method may 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, the buffer was too small, so the string was truncated.

Remarks

For more information, see Target Information.

Requirements

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