FesfSaReadHeader function

Reads the Application Header.

Syntax

bool

FesfSaReadHeader(

    _In_ const wchar_t *Path,

    _Inout_opt_bytecount_( SolutionHeaderSize) void * SolutionHeader,

    _In_  uint32_t SolutionHeaderSize,

    _Out_ uint32_t *BytesRead

)

Parameters

Path [in]

A string containing the path of a file whose solution header should be read.

SolutionHeader [out, retval]

A caller allocated buffer to receive the solution header.

SolutionHeaderSize [in]

The size of the caller allocated buffer in bytes.

BytesRead [out]

A pointer to an integer which will receive the size of the solution header.

Return value

Returns TRUE if the header was successfully read, FALSE otherwise.

For Windows platforms, a specific status code for this function is reported with SetLastError().

For Linux platforms, the errno variable should be set to report a specific error code.

Remarks

Path is interpreted as a fully qualified path, suitable for direct evaluation.

If the supplied buffer is too small then FALSE is returned, but BytesRead is set to the size of the solution header in the file.  Additionally, in this situation, for Windows platforms GetLastError is set to be ERROR_BUFFER_OVERFLOW, and for non-Windows platforms errno is set to be –E2BIG.

In all other error cases BytesRead is set to be 0XFFFFFF.

Examples

See Also

Requirements