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

GetScopeAsText Method

Previous pageReturn to chapter overviewNext page

描述

 

IWbemPath.GetScopeAsText方法基于索引检索文本格式的范围。对于Windows XP,索引必须为零(0),范围是路径的类或键部分。

 

C++ 语法

 

HRESULT GetScopeAsText(

[in]       ULONG uIndex,

[in, out]  ULONG *puTextBufSize,

[out]      LPWSTR pszText

);

 

PowerBASIC 语法

 

METHOD GetScopeAsText ( _

BYVAL uIndex AS DWORD, _

BYREF puTextBufSize AS DWORD, _

BYREF pszText AS WSTRINGZ _

) AS LONG

 

参数

 

uIndex

 

范围索引。

 

puTextBufSize

 

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

 

pszText

 

要复制范围的缓冲区。

 

返回值

 

此方法返回以下值之一。

 

退货代码

描述

S_OK

方法成功执行

WBEM_E_BUFFER_TOO_SMALL

缓冲区不够大

WBEM_E_INVALID_PARAMETER

表示以下三个条件之一:

 

·puTextBufSize参数为NULL。
·puTextBufSize表示非零长度缓冲区,但缓冲区为NULL。
·索引值超出范围。

WBEM_E_OUT_OF_MEMORY

内存不足以执行此方法。

 

备注

 

该方法可用于确定pszText需要多大的缓冲区。这通过传递缓冲区的NULL指针,将puTextBufSize设置为零(0),然后进行调用。返回时,puTextBufSize表示pszText及其终止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。