SDKHelp is provided as a value add item based on a number of user requests. SDKHelp provides MicroStation CONNECT SDK developers - a single, simple and unified view from which to Explore and Search the most commonly used MicroStation (and Microsoft) API CHM Help File resources all from one convenient help file (SDKHelp.chm). The SDKHelp.chm file provided was created using the Microsoft HTML Workshop (Download) and creating a Help File Merge Project. Think of a merge file being very similar to MicroStation "reference files" or Autodesk "x-refs". The parent CHM help file (SDKHelp.chm) references other dependent CHM files that are required to all be accessed within the same product documentation folder. Once all merge file links are created, topics and layouts performed, then all that remains is to create/provide a Welcome Page (similar to below) to providing some orientation for developers to best get started, resources and search tips to help ensure maximum productivity and self-help results can be achieved.
So, what do you need to do?
- Download SDKHelp.zip
- Extract under your location of the MicroStation CONNECT Edition SDK "Documentation" folder
- e.g. C:\Program Files\Bentley\MicroStationCONNECTSDK\Documentation
NOTE: If prompted to use admin permissions; Select the Continue (button)
- Open the MicroStation Developer Shell (Run as Admin)
- Type: SDKHelp
If the files are extracted to the correct locations you should see sample output like the image below and the (sdkdocs) ..\documentation\SDKHelp.chm file open to Search and Explore.
We sure hope you find this new value added feature helpful and enjoy using it!