Important: The information in this document is obsolete and should not be used for new development.
GetStandardFormats
You probably do not need to call theGetStandardFormats
function directly because the Edition Manager calls this function.
FUNCTION GetStandardFormats (container: EditionContainerSpec; VAR previewFormat: FormatType; preview, publisherAlias, formats: Handle): OSErr;
container
- An edition container record that specifies the edition volume reference number, directory ID, filename, and part.
previewFormat
- The
GetStandardFormats
function returns in this parameter a handle to the first format of the requested format type that it finds in the edition.preview
- A format type. The
GetStandardFormats
function looks for a format of the type specified in this parameter and returns in this parameter the format type of the first format that it finds. The function tries to find one of four formats:'prvw'
,'PICT'
,'TEXT'
, or'snd '
.publisherAlias
- The
publisherAlias
parameter reads the formatkPublisherDocAliasFormat
('alis'
).formats
- The
formats
parameter reads the virtual formatkFormatListFormat
('fmts'
).DESCRIPTION
You should pass in valid handles for the formats that you want andNIL
for the formats that you don't want. The handles are resized to the size of the data.If one of the requested formats cannot be found,
GetStandardFormats
returns anoTypeErr
result code.RESULT CODES
noErr 0 No error noTypeErr -102 Edition container not found editionMgrInitErr -450 Manager not initialized