Edit

IWbemPathKeyList::GetText method (wmiutils.h)

  • Article

The IWbemPathKeyList::GetText method retrieves the key list as text.

Syntax

HRESULT GetText(
  [in]      long   lFlags,
  [in, out] ULONG  *puBuffLength,
  [in, out] LPWSTR pszText
);

Parameters

[in] lFlags

Flags which control the format of the text. The following list lists the valid flag values.

WBEMPATH_QUOTEDTEXT

Places quotes around the string key values.

WBEMPATH_TEXT

Not used.

[in, out] puBuffLength

Caller sets this to the number of characters that the buffer can hold. Upon success, this is set to the number of characters copied into the buffer, including the NULL terminator.

[in, out] pszText

Buffer into which the text is copied.

Return value

This method returns an HRESULT indicating the status of the method call.

Remarks

This method can be used to determine how big a buffer is needed by passing in a NULL pointer for the buffer and setting its size parameter to 0 (zero). Upon return, the buffer's size parameter indicates how large of a buffer is needed for the string and its NULL terminator.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header wmiutils.h
Library Wbemuuid.lib
DLL Wmiutils.dll

See also

IWbemPath

IWbemPathKeyList