ToString(StatusFormatFlags,string,string) Method

Summary

This method returns a customizable string representation of the StatusBase object.

Syntax

C++

public virtual string ToString( 
   StatusFormatFlags statusFormatFlags, 
   string separator, 
   string tab 
)

Public Overridable Function ToString( 
   ByVal statusFormatFlags As StatusFormatFlags, 
   ByVal separator As String, 
   ByVal tab As String 
) As String

public:  
   virtual String^ ToString( 
      StatusFormatFlags^ statusFormatFlags, 
      String^ separator, 
      String^ tab 
   )

Parameters

statusFormatFlags

Flags that specify which members to exclude in the string representation of this object

separator

A separator string that is used to separate the string representation of each class member

tab

An indent string that is used to indent the string representation of each class member

Return Value

A customizable string representation of the StatusBase object.

Remarks

The string representation of this object, where each member of the class is prefixed by a separator string followed by a tab string. To customize the string representation so that each member is on its own line and tab indented, pass the newline character '\n' for separator and the tab character '\t' for tab.

The StatusFormatFlags provide further customization by allowing you to specify certain members to ignore. For more details, see StatusFormatFlags.

Requirements

Target Platforms