FamilyUtils.ConvertFamilyToFaceHostBased
Description:
Converts a family to be face host based.
Converts a family to be face host based.
Remarks:
Converts a family hosted by some element other than a face to be hosted by a face. This is done by replacing the existing host (wall, roof, ceiling, floor) with a face. Conversion can succeed only if FamilyUtils.FamilyCanConvertToFaceHostBased() returns true.
Converts a family hosted by some element other than a face to be hosted by a face. This is done by replacing the existing host (wall, roof, ceiling, floor) with a face. Conversion can succeed only if FamilyUtils.FamilyCanConvertToFaceHostBased() returns true.
-
documentThe document containing the family to be converted.
-
familyIdThe family id.
-
The input familyId cannot be converted to face host based.
-
A non-optional argument was NULL
-
Failed to convert the family to face host based. -or- The family is already unhosted.