WSManCreateSession 函数 (wsman.h)
创建会话对象。
语法
DWORD WSManCreateSession(
[in] WSMAN_API_HANDLE apiHandle,
[in, optional] PCWSTR connection,
DWORD flags,
[in, optional] WSMAN_AUTHENTICATION_CREDENTIALS *serverAuthenticationCredentials,
[in, optional] WSMAN_PROXY_INFO *proxyInfo,
[out] WSMAN_SESSION_HANDLE *session
);
参数
[in] apiHandle
指定 由 WSManInitialize 调用返回的 API 句柄。 此参数不能为 NULL。
[in, optional] connection
指示要连接到哪个协议和代理。 如果此参数为 NULL,则连接将默认为 localhost (127.0.0.1) 。 此参数可以是简单的主机名或完整的 URL。 格式如下:
[transport://]host[:p ort][/prefix] ,其中:
元素 | 说明 |
---|---|
运输 | HTTP 或 HTTPS。 默认值为 HTTP。 |
host | 可以是 DNS 名称、NetBIOS 名称或 IP 地址。 |
port | 对于 HTTP,默认值为 80,对于 HTTPS,默认为 443。 可以在本地配置中更改默认值。 |
前缀 | 任何字符串。 默认值为“wsman”。 可以在本地配置中更改默认值。 |
flags
保留供将来使用。 必须为零。
[in, optional] serverAuthenticationCredentials
定义身份验证方法,例如 Negotiate、Kerberos、Digest、Basic 或客户端证书。 如果身份验证机制为 Negotiate、Kerberos、Digest 或 Basic,则结构还可以包含用于身份验证的凭据。 如果使用客户端证书身份验证,则必须指定证书指纹。
如果指定了凭据,则此参数包含本地帐户或域帐户的用户名和密码。 如果此参数为 NULL,则使用默认凭据。 默认凭据是当前线程执行时使用的凭据。 使用基本或摘要式身份验证时,客户端必须显式指定凭据。 如果使用显式凭据,则用户名和密码都必须有效。 有关身份验证凭据的详细信息,请参阅 WSMAN_AUTHENTICATION_CREDENTIALS 结构。
[in, optional] proxyInfo
指向指定代理信息的 WSMAN_PROXY_INFO 结构的指针。 此值可以为 NULL。
[out] session
定义唯一标识会话的会话句柄。 此参数不能为 NULL。 应通过调用 WSManCloseSession 方法关闭此句柄。
返回值
如果函数成功,则返回值为 0。 否则,返回值为错误代码。
要求
最低受支持的客户端 | Windows 7 |
最低受支持的服务器 | Windows Server 2008 R2 |
目标平台 | Windows |
标头 | wsman.h |
Library | WsmSvc.lib |
DLL | WsmSvc.dll |
可再发行组件 | Windows Server 2008 SP2 和 Windows Vista SP2 上的Windows Management Framework |