Enables a user to retrieve the sealed client-principal associated with the current connection to the Business Process Server (BP Server). The client-principal holds the credentials of the user logged-in to the BP Server.
The UserSession object uses the BP Server SessionId (stored in the UserSession object when the CONNECT( ) method is successfully called) to retrieve the client-principal stored in the BP Server session context. If a valid connection to the BP Server does not exist at the time the GetClientPrincipal( ) method is called, a BPMError object is thrown.