ItsPubPlugin2::ResolvePersonalDesktop method

Called to resolve a mapping between the specified user and a virtual machine in a personal virtual desktop collection.

Syntax


HRESULT ResolvePersonalDesktop(
  [in]  const wchar_t                         *userId,
  [in]  const wchar_t                         *poolId,
  [in]        TSPUB_PLUGIN_PD_RESOLUTION_TYPE ePdResolutionType,
  [out]       TSPUB_PLUGIN_PD_ASSIGNMENT_TYPE *pPdAssignmentType,
  [out]       wchar_t                         endPointName[MAX_ENDPOINT_SIZE]
);

Parameters

userId [in]

A null-terminated string that contains the security identifier (SID) of the user.

poolId [in]

A null-terminated string that contains the identifier of the collection to obtain the personal desktop from or create the personal desktop in.

ePdResolutionType [in]

A value of the TSPUB_PLUGIN_PD_RESOLUTION_TYPE enumeration that specifies the type of resolution being requested.

pPdAssignmentType [out]

A value of the TSPUB_PLUGIN_PD_ASSIGNMENT_TYPE enumeration that specifies what type of assignment was made for the personal desktop.

endPointName [out]

A null-terminated string that receives the name of the end point for the desktop. The length of this string is limited to MAX_ENDPOINT_SIZE characters, including the terminating NULL character.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

MAX_ENDPOINT_SIZE is declared as follows:

#define MAX_ENDPOINT_SIZE 256

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

IDL

Tspubplugin2com.idl

See also

ItsPubPlugin2

 

 

Show: