Inside Macintosh: Apple Game Sprockets Guide /

Chapter 4 - NetSprocket / NetSprocket Reference

NetSprocket Functions / Managing Network Protocols

NSpProtocol_ExtractDefinitionString

You can use the NSpProtocol_ExtractDefinitionString function to copy the definition string of the given protocol into the provided buffer.

OSStatus NSpProtocol_ExtractDefinitionString (
	NSpProtocolReference inProtocolRef,
	char *outDefinitionString);

inProtocolRef

An opaque reference to the protocol for which you want the definition string.

outDefinitionString

A buffer you allocate into which the string is copied. Use the constant kNSpMaxDefinitionStringLen to allocate the memory.

function result

A result code of noErr, or a NetSprocket or Open Transport result code.

DESCRIPTION

You can extract the definition string to clone the protocol reference or modify it for use when you create a new protocol reference. Even though this function is implemented in NetSprocket version 1.0, it does not support the creation of protocols with definition strings directly.