Legacy Document

Inside Macintosh: Networking With Open Transport / Part 2 - Open Transport Reference

Chapter 25 - Option Management Reference / Functions

Manipulating the Format of Option Information /

OTCreateOptionString

Creates a string from a buffer containing TOption structures.

C INTERFACE

OSStatus OTCreateOptionString (const char* endptName, TOption** opt,
                                          void* bufEnd, char* string,
                                          size_t stringSize);

C++ INTERFACE

None. C++ applications use the C interface to this function.

PARAMETERS

endptName

A constant specifying the name of the protocol for this option or options.

opt

A pointer to a pointer to a buffer containing one or more TOption structures.

bufEnd

A pointer to the first byte of memory past the last option.

string

A pointer to a buffer where the string is to be stored. You must allocate this buffer.

stringSize

The length of the buffer where the string is to be stored. You must specify this value.

function result

See Appendix B.

DISCUSSION

You can use the OTCreateOptionString function to parse through the options buffer returned by the ret parameter to the OTOptionMangement function and create a string specifying option values that you can display.

SPECIAL CONSIDERATIONS

This function is supplied solely as a debugging aid. You should not include the function in a production version of your application because there is no provision made for localizing string information.

SEE ALSO

The OTCreateOptions function.