IVsStatusbar.Progress 方法
显示占用确定时间量的操作的进度。
命名空间: Microsoft.VisualStudio.Shell.Interop
程序集: Microsoft.VisualStudio.Shell.Interop(在 Microsoft.VisualStudio.Shell.Interop.dll 中)
语法
声明
Function Progress ( _
<OutAttribute> ByRef pdwCookie As UInteger, _
fInProgress As Integer, _
pwszLabel As String, _
nComplete As UInteger, _
nTotal As UInteger _
) As Integer
int Progress(
out uint pdwCookie,
int fInProgress,
string pwszLabel,
uint nComplete,
uint nTotal
)
参数
- pdwCookie
类型:System.UInt32%
[in, out] 当前用户的 ID,同时防止他人进度栏的各种用法。
- fInProgress
类型:System.Int32
[in] true ,在进度栏正在使用时;错误,则完成。
- pwszLabel
类型:System.String
[in] ,在进度栏正在使用时,请文本显示在状态字段。
- nComplete
类型:System.UInt32
[in] 单元数在进度栏当前完成。
- nTotal
类型:System.UInt32
[in] 始终单位数量进度栏操作的。
返回值
类型:System.Int32
如果方法成功,则返回 S_OK。如果失败,它会返回一个错误代码。
备注
COM 签名
从 vsshell.idl:
HRESULT IVsStatusbar::Progress(
[in,out]VSCOOKIE *pdwCookie,
[in]BOOL fInProgress,
[in]LPCOLESTR pwszLabel,
[in]ULONG nComplete,
[in]ULONG nTotal
);
进度在状态栏中显示进度栏区域显示为一个其蓝色竖线。 首次状态栏用户调用此方法,必须设置 pdwCookie 为零。 在 pdwCookie 然后返回的值是该状态栏用户必须使用向前调用此方法的唯一 ID。
此方法调用显示在操作中进行的数量的进度。 同样, nTotal ,在调用此方法之前,必须知道。 如果 nTotal 无法事先确定,并执行比两个三秒应采用更多信息,请 Animation 调用方法。
.NET Framework 安全性
- 对直接调用方的完全信任。此成员不能由部分信任的代码使用。有关更多信息,请参见通过部分受信任的代码使用库。