INetSchema.GetAncillaryRole Method

Returns the ancillary role type and the name of the field containing the ancillary role information.

[Visual Basic .NET]
Public Sub GetAncillaryRole ( _
    ByVal UserClassID As Integer, _
    ByRef ancillaryRole As esriNetworkClassAncillaryRole, _
    ByRef AncillaryRoleFieldName As String _
)

[C#]
public void GetAncillaryRole (
    int UserClassID,
    ref esriNetworkClassAncillaryRole ancillaryRole,
    ref string AncillaryRoleFieldName
);

[C++]
HRESULT GetAncillaryRole(
  long UserClassID,
  esriNetworkClassAncillaryRole* ancillaryRole,
  BSTR* AncillaryRoleFieldName
);

[C++]
Parameters
UserClassID [in]
  UserClassID is a parameter of type long
ancillaryRole [out]
  ancillaryRole is a parameter of type esriNetworkClassAncillaryRole
AncillaryRoleFieldName [out]
  AncillaryRoleFieldName is a parameter of type BSTR

Product Availability

Remarks

GetAncillaryRole returns the AncillaryRole (0 - no role, 1 - source or sink) and field name for the specified object class.  The returned field name is an empty string ("") when the anciallyRole is 0 (no role).

Initialize the output parameters as an esriNetworkClassAncillaryRole (ancillaryRole) and a string (ancillaryRoleFieldName).

See Also