Skip to content

Latest commit

 

History

History
185 lines (152 loc) · 5.96 KB

nf-tsuserex-iadstsuserex-get_terminalservicesprofilepath.md

File metadata and controls

185 lines (152 loc) · 5.96 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:tsuserex.IADsTSUserEx.get_TerminalServicesProfilePath
IADsTSUserEx::get_TerminalServicesProfilePath (tsuserex.h)
The roaming or mandatory profile path to be used when the user logs on to the Remote Desktop Session Host (RD Session Host) server. (Get)
IADsTSUserEx interface [Remote Desktop Services]
TerminalServicesProfilePath property
IADsTSUserEx.TerminalServicesProfilePath
IADsTSUserEx.get_TerminalServicesProfilePath
IADsTSUserEx::TerminalServicesProfilePath
IADsTSUserEx::get_TerminalServicesProfilePath
IADsTSUserEx::put_TerminalServicesProfilePath
TerminalServicesProfilePath property [Remote Desktop Services]
TerminalServicesProfilePath property [Remote Desktop Services]
IADsTSUserEx interface
get_TerminalServicesProfilePath
termserv.iadstsuserex_terminalservicesprofilepath
tsuserex/IADsTSUserEx::TerminalServicesProfilePath
tsuserex/IADsTSUserEx::get_TerminalServicesProfilePath
tsuserex/IADsTSUserEx::put_TerminalServicesProfilePath
termserv\iadstsuserex_terminalservicesprofilepath.htm
TermServ
282c20ab-378d-4205-90d3-6d28b0770adc
12/05/2018
IADsTSUserEx interface [Remote Desktop Services],TerminalServicesProfilePath property, IADsTSUserEx.TerminalServicesProfilePath, IADsTSUserEx.get_TerminalServicesProfilePath, IADsTSUserEx::TerminalServicesProfilePath, IADsTSUserEx::get_TerminalServicesProfilePath, IADsTSUserEx::put_TerminalServicesProfilePath, TerminalServicesProfilePath property [Remote Desktop Services], TerminalServicesProfilePath property [Remote Desktop Services],IADsTSUserEx interface, get_TerminalServicesProfilePath, termserv.iadstsuserex_terminalservicesprofilepath, tsuserex/IADsTSUserEx::TerminalServicesProfilePath, tsuserex/IADsTSUserEx::get_TerminalServicesProfilePath, tsuserex/IADsTSUserEx::put_TerminalServicesProfilePath
tsuserex.h
Tsuserex.h, Tsuserex_i.c
Windows
Windows Vista
Windows Server 2008
Tsuserex.tlb
Tsuserex.dll
Windows
19H1
IADsTSUserEx::get_TerminalServicesProfilePath
tsuserex/IADsTSUserEx::get_TerminalServicesProfilePath
c++
APIRef
kbSyntax
COM
Tsuserex.dll
IADsTSUserEx.TerminalServicesProfilePath
IADsTSUserEx.get_TerminalServicesProfilePath
IADsTSUserEx.put_TerminalServicesProfilePath

IADsTSUserEx::get_TerminalServicesProfilePath

-description

The roaming or mandatory profile path to be used when the user logs on to the Remote Desktop Session Host (RD Session Host) server.

This property is read/write.

-parameters

-remarks

The profile path is in the following network path format:

\\ServerName\ProfilesFolderName\UserName

Note  A Remote Desktop Services profile path is used only for logging on to an RD Session Host server.
 

Examples

The following example shows a program that binds to the Active Directory database without credentials.

 IADsContainer *pContainer = NULL;
 IDispatch *pNewObject = NULL;
 IADsTSUserEx *pTSUser = NULL;
 IADsUser *pUser = NULL;
 HRESULT hr = ERROR_SUCCESS;

 CoInitialize(NULL);
 //
 // Bind to the known container.
 //
 hr = ADsGetObject(
    L"LDAP://DOMAIN/CN=Users,DC=Server1,DC=Domain,DC=com",
    IID_IADsContainer,
    (void**)&pContainer);

 if( !SUCCEEDED(hr)) {
  wprintf(L"ADsGetObject ret failed with 0x%x\n", hr);
  return FALSE;
 }
 //
 // Create the new Active Directory Service Interfaces User object.
 //
 hr = pContainer->Create(L"user",
                         L"cn=test3",
                         &pNewObject);
 pContainer->Release();

 if( !SUCCEEDED(hr)) {
  wprintf(L"Create ret failed with 0x%x\n", hr);
  return FALSE;
 }
 //
 // Get the IADsTSUser interface from the user object.
 //
 hr = pNewObject->QueryInterface(IID_IADsTSUserEx, (void**)&pTSUser);

 if( !SUCCEEDED(hr)) { 
  wprintf(L"QueryInterface for IADsTSUserEx failed with ret 0x%x\n",
          hr);
  return FALSE;
 }
 //
 // Get the IADsTSUser interface from the user object.
 //
 hr = pNewObject->QueryInterface(IID_IADsUser, (void**)&pUser);

 if( !SUCCEEDED(hr)) {
  wprintf(L"QueryInterface for IAsUser failed with 0x%x\n", hr);
  return FALSE;
 }
 pNewObject->Release();

 //
 // Set TerminalServicesProfilePath
 //
 pTSUser->put_TerminalServicesProfilePath(L"c:\\windows");
 pTSUser->Release();

 //
 // Commit the object data to the directory.
 //
 pUser->SetInfo();
 pUser->Release();
 CoUninitialize();

You can use the following script examples to bind to a provider's namespace. Two examples bind with supplied credentials; two bind without credentials.

The first example shows a script that binds to the Security Accounts Manager (SAM) database with the supplied credentials.

The second example shows a script that binds to the Active Directory database with the supplied credentials.

Set DSO = GetObject("WinNT:")
Set usr = DSO.OpenDSObject(
    "WinNT://Server1/Test,user",
    Domain\User,
    Password,
    ADS_SECURE_AUTHENTICATION)
Wscript.echo usr.TerminalServicesProfilePath
usr.TerminalServicesProfilePath = "profile path"
usr.SetInfo
WScript.echo usr.TerminalServicesProfilePath
Set DSO = GetObject("LDAP:")
Set usr = DSO.OpenDSObject(
    "LDAP://DOMAIN/CN=Test,CN=Users,DC=Server1,DC=Domain,DC=com",
    Domain\User,
    Password,
    ADS_SECURE_AUTHENTICATION)
Wscript.echo usr.TerminalServicesProfilePath
usr.TerminalServicesProfilePath = "profile path"
usr.SetInfo
WScript.echo usr.TerminalServicesProfilePath

-see-also

IADsTSUserEx