IVersionedRelationship::Pin

See Also

Declares a specific target object version of an origin relationship to be the pinned version.

HRESULT Pin(
IRepositoryObjectVersion *pIReposVersion
);

Parameters

*pIReposVersion

[in]
The IRepositoryObjectVersion interface pointer for the object version to be pinned.

Return Value

S_OK

The method completed successfully.

Error

Values

This method failed to complete successfully.

Remarks

You can use this method only for origin relationships. The origin object of the versioned relationship must be unfrozen.

If the origin object of the relationship is checked out to a workspace, the Pin method will work only from within that workspace.

When you pin a target object version for versioned relationship, any previously pinned target object version of the relationship becomes unpinned.

The target object version to be pinned must already participate in the relationship.