IDataServiceStreamProvider.GetReadStreamUri Method

Reference

Definition

Namespace:: System.Data.Services.Providers

Assembly:: System.Data.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the URI that is used to request the media resource that belongs to the specified entity.

public:
 Uri ^ GetReadStreamUri(System::Object ^ entity, System::Data::Services::DataServiceOperationContext ^ operationContext);

public Uri GetReadStreamUri (object entity, System.Data.Services.DataServiceOperationContext operationContext);

abstract member GetReadStreamUri : obj * System.Data.Services.DataServiceOperationContext -> Uri

Public Function GetReadStreamUri (entity As Object, operationContext As DataServiceOperationContext) As Uri

Parameters

entity: Object

The entity that is a media link entry with a related media resource.

operationContext: DataServiceOperationContext

The DataServiceOperationContext instance used by the data service to process the request.

Returns

Uri

A Uri value that is used to request the binary data stream.

Remarks

The GetReadStreamUri method is called by the data service runtime to obtain the URI that clients should use when they make retrieve (that is, GET) requests for the media resource.

The Uri value returned by the GetReadStreamUri method implementation is used as the edit-media link in the media link entry to references the location of the media resource.

When the method implementation returns null, the data service will construct a default Uri, which is usually the URI of the entity appended with /$value.

Applies to