This commit is contained in:
jcarsey
2009-06-10 17:07:59 +00:00
parent ebdad7f865
commit b4124f44f7
2 changed files with 32 additions and 40 deletions

View File

@ -1,5 +1,5 @@
/** @file
This file declares Section Extraction protocols.
This file declares Section Extraction Protocol.
This interface provides a means of decoding a set of sections into a linked list of
leaf sections. This provides for an extensible and flexible file format.
@ -71,7 +71,10 @@ EFI_STATUS
@param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
@param SectionStreamHandle Indicates from which section stream to read.
@param SectionType Pointer to an EFI_SECTION_TYPE.
@param SectionType Pointer to an EFI_SECTION_TYPE. SectionType == NULL, the contents of the
entire section stream are returned in Buffer.If SectionType is not NULL,
only the requested section is returned. EFI_SECTION_ALL matches all section
types and can be used as a wild card to extract all sections in order.
@param SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==
EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID
to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then
@ -135,25 +138,19 @@ EFI_STATUS
//
// Protocol definition
//
/**
@par Protocol Description:
The Section Extraction Protocol provides a simple method of extracting
sections from arbitrarily complex files.
@param OpenSectionStream
Takes a bounded stream of sections and returns a section stream handle.
@param GetSection
Given a section stream handle, retrieves the requested section and
meta-data from the section stream.
@param CloseSectionStream
Given a section stream handle, closes the section stream.
**/
struct _EFI_SECTION_EXTRACTION_PROTOCOL {
///
/// Takes a bounded stream of sections and returns a section stream handle.
///
EFI_OPEN_SECTION_STREAM OpenSectionStream;
///
/// Given a section stream handle, retrieves the requested section and
/// meta-data from the section stream.
///
EFI_GET_SECTION GetSection;
///
/// Given a section stream handle, closes the section stream.
///
EFI_CLOSE_SECTION_STREAM CloseSectionStream;
};