WdsCliCreateSession function

Starts a new session with a WDS server.

Syntax


HRESULT WDSCLIAPI WdsCliCreateSession(
  _In_      PWSTR pwszServer,
  _In_opt_  PWDS_CLI_CRED pCred,
  _Out_     PHANDLE phSession
);

Parameters

pwszServer [in]

A pointer to a string value that contains the name or IP address of the WDS server.

pCred [in, optional]

A pointer to a WDS_CLI_CRED structure that contains the client's credentials. This parameter can be null for a session without authentication.

phSession [out]

A pointer to a handle for the new session. This parameter is unmodified if the function is unsuccessful.

Return value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To get extended error information, call GetLastError.

Remarks

To close the session and release resources, use the WdsCliClose function.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

WdsClientAPI.h

Library

WdsClientAPI.lib

DLL

WdsClientAPI.dll

See also

Windows Deployment Services Client Functions
WDS_CLI_CRED
WdsCliClose

 

 

Community Additions

ADD
Show:
© 2014 Microsoft