勇芳软件工作室.汉化:  Windows Management Instrumentation > COM API for WMI > Interfaces > IWbemPathKeyList >

GetKey Method

Previous pageReturn to chapter overviewNext page

描述

 

IWbemPathKeyList.GetKey方法检索密钥的名称或值。键从0(零)索引,尽管键的顺序不重要。

 

C++ 语法

 

HRESULT GetKey(

[in]       ULONG uKeyIx,

[in]       ULONG uFlags,

[in, out]  ULONG *puNameBufSize,

[in, out]  LPWSTR pszKeyName,

[in, out]  ULONG *puKeyValBufSize,

[in, out]  LPVOID pKeyVal,

[in, out]  ULONG *puApparentCimType

);

 

PowerBASIC 语法

 

METHOD GetKey ( _

BYVAL uKeyIx AS DWORD, _

BYVAL uFlags AS DWORD, _

BYREF puNameBufSize AS DWORD, _

BYREF pszKeyName AS WSTRINGZ, _

BYREF puKeyValBufSize AS DWORD, _

BYVAL pKeyVal AS DWORD, _

BYREF puApparentCimType AS DWORD _

);

 

参数

 

uKeyIx

 

键索引从0开始(零)。

 

uFlags

 

保留。必须为0(零)。

 

puNameBufSize

 

来电者将此设置为名称缓冲区可以容纳的字符数。成功后,将其设置为复制到包含终止NULL的缓冲区—中的字符数。

 

pszKeyName

 

要复制名称的缓冲区。因为并不是所有的键都有一个名称,所以这个参数值对于一个隐式键是NULL。

 

puKeyValBufSize

 

来电者将此值设置为值缓冲区可以容纳的字符数。成功后,将其设置为复制到包含NULL终止符的缓冲区中的字符数。

 

pKeyVal

 

要复制数据的缓冲区

 

puApparentCimType

 

指向长度的指针,设置为CIM类型。

 

返回值

 

此方法返回一个HRESULT,指示方法调用的状态。

 

退货代码

描述

S_OK

方法成功执行

WBEM_E_INVALID_PARAMETER

一个或多个参数无效。

WBEM_E_OUT_OF_MEMORY

内存不足以执行操作。

 

备注

 

推荐做法是通过调用此方法,传递缓冲区的NULL指针,并将其size参数设置为0(零)来确定需要多大的缓冲区。返回时,缓冲区的size参数指示字符串及其NULL终止符需要多大的缓冲区。然后可以调用该方法来获取缓冲区值。

 

Windows 2000 / NT:需要WMI SDK Update或Microsoft .NET Framework SDK。

 

Windows NT:需要Microsoft .NET Framework SDK。

 

要求

 

客户

需要Windows Vista或Windows XP。

服务器

需要Windows Server 2008或Windows Server 2003。

可再发行

需要Windows 2000和Windows NT上的WMI可重新分发组件版本1.0。在Windows NT上,它也需要Microsoft .NET Framework。

在Wmiutils.inc中声明。

DLL

需要Wmiutils.dll。