CoMarshalHresult

Marshals an HRESULT to the specified stream so it can be unmarshaled using the CoUnmarshalHresult function.

STDAPI CoMarshalHresult(

IStream * pStm,	//Stream to be used for marshalling
HRESULT hresult	//HRESULT to be marshalled
);

Parameters
pStm

Points to the stream used for marshalling.

hresult

Specifies the HRESULT in the originating process.

Return Values
S_OK

Indicates the HRESULT was marshalled successfully.

STG_E_INVALIDPOINTER

Indicates bad pointer passed in for pStm.

STG_E_MEDIUMFULL

Indicates the medium is full.

E_OUTOFMEMORY

Out of memory.

E_INVALIDARG

Indicates one or more arguments are invalid.

E_UNEXPECTED

Indicates an unexpected error occurred.

Comments
You typically do not need to call this function. If you are performing custom marshalling (that is, writing your own implementation of IMarshal) and you need to marshal an HRESULT from one process to another, either as a parameter or a return code, you must call this function. An HRESULT is process-specific, so an HRESULT valid in one process might not be valid in another.

Note that the HRESULT returned by CoMarshalHresult indicates the success or failure of the marshalling process and is unrelated to the HRESULT parameter.