Windows Dev Center

IWbemPathKeyList::GetText method

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

lFlags [in]

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

FlagMeaning
WBEMPATH_QUOTEDTEXT

Places quotes around the string key values.

WBEMPATH_TEXT

Not used.

 

puBuffLength [in, out]

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.

pszText [in, out]

Buffer into which the text is copied.

Return value

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

Return codeDescription
S_OK

Method executed successfully.

WBEM_E_INVALID_PARAMETER

One or more of the parameters are not valid.

WBEM_E_OUT_OF_MEMORY

Insufficient memory to perform the operation.

 

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

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Header

Wmiutils.h

Library

Wbemuuid.lib

DLL

Wmiutils.dll

See also

IWbemPath
IWbemPathKeyList

 

 

Show:
© 2015 Microsoft