Public Member Functions | List of all members
CommitInfo Class Reference

Associates a user name and a description with a set of changes recorded in design history. More...

#include <DgnHistory.h>

Public Member Functions

DGNPLATFORM_EXPORT CommitInfo (WString const &desc)
 flags More...
 
DGNPLATFORM_EXPORT void SetUserName (WCharCP userName)
 Set the user name. More...
 
DGNPLATFORM_EXPORT bool IsValid () const
 Check if commit parms is in a valid state. More...
 

Detailed Description

Associates a user name and a description with a set of changes recorded in design history.

The user name and description string are saved in design history with the changes and may be viewed later on as documentation for the change. These strings are for documentation purposes only and is not used by MicroStation.

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Constructor & Destructor Documentation

flags

Set up commit info with a description and the current user name.

Member Function Documentation

DGNPLATFORM_EXPORT bool IsValid ( ) const

Check if commit parms is in a valid state.

DGNPLATFORM_EXPORT void SetUserName ( WCharCP  userName)

Set the user name.


The documentation for this class was generated from the following file:

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.