It's been a while since I have done it, but my recollection is using sprintf to get the string formatted with the line breaks and then passing the resulting string to the dialog box.
This was before ProUIMessageDialogDisplay(). I had created my own utility function that did the same thing. I should have patented the thing. PTC would be paying me royalties and I wouldn't have to work.