All Frameworks  Class Hierarchy  This Framework  Indexes

ApplicationFrame Global Function CATAfrGetWorkbenchIdentifierFromNLSName


HRESULT CATAfrGetWorkbenchIdentifierFromNLSName( const CATUnicodeString& iWorkbenchNLSName,
CATString& oWorkbenchId)
Gets the identifier of a workbench.
Role: This method gets the identifier of a workbench from its user name.
The workbench identifier is the internal name given to the workbench when it was created ( CATIWorkbench.CreateWorkbench).
The workbench user name is the NLS string which appears in the Start menu.
Parameters:
iWorkbenchNLSName
The NLS name of the workbench.
oWorkbenchId
The identifier of the workbench.
Returns:
S_OK
if the workbench was found
E_FAIL
if the workbench was not found

This object is included in the file: CATAfrWorkbenchServices.h

Copyright © 2003, Dassault Systèmes. All rights reserved.