Gets a description of a voice by using the
- macOS 10.0+
A pointer to the voice specification structure identifying the voice to be described, or
NULLto obtain a description of the system default voice.
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 the
voiceparameter specifies an available voice and, if not, returns a
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
Sizefunction to determine the length of this structure.
A result code. See Result Codes.
fills out the voice description structure pointed to by the
with the correct information for the voice specified by the
voice parameter. It
fills in the
of the voice description structure with the number of bytes actually
copied. This value will always be less than or equal to the value
that your application passes in
This scheme allows applications targeted for the current version
of the Speech Synthesis Manager to work on future versions that
might have longer voice description structures; it also allows you
to write code for future versions of the Speech Synthesis Manager
that will also run on computers that support only the current version.
If the voice specification structure does not identify an