GetVoiceDescription(_:_:_:)
Gets a description of a voice by using the GetVoiceDescription function.
Declaration
func GetVoiceDescription(_ voice: UnsafePointer<VoiceSpec>?, _ info: UnsafeMutablePointer<VoiceDescription>?, _ infoLength: Int) -> OSErrParameters
- voice:
A pointer to the voice specification structure identifying the voice to be described, or
NULLto obtain a description of the system default voice. - info:
A pointer to a voice description structure. If this parameter is
NULL, the function does not fill in the fields of the voice description structure; instead, it simply determines whether thevoiceparameter specifies an available voice and, if not, returns avoiceNotFounderror. - infoLength:
The length, in bytes, of the voice description structure. In the current version of the Speech Synthesis Manager, the voice description structure contains 362 bytes. However, you should always use the
SizeOffunction to determine the length of this structure.
Return Value
A resultcode. See Result Codes.
Discussion
The GetVoiceDescription functionfills out the voice description structure pointed to by the info parameterwith the correct information for the voice specified by the voice parameter. Itfills in the length fieldof the voice description structure with the number of bytes actuallycopied. This value will always be less than or equal to the valuethat your application passes in infoLength beforecalling GetVoiceDescription.This scheme allows applications targeted for the current versionof the Speech Synthesis Manager to work on future versions thatmight have longer voice description structures; it also allows youto write code for future versions of the Speech Synthesis Managerthat will also run on computers that support only the current version.
If the voice specification structure does not identify anavailable voice, GetVoiceDescription returnsa voiceNotFound error.