SamgrLite

    Samgr

    Description:

    Represents the system ability management class.

    This class is used for registering and discovering services, features, and functions.

    Since:

    1.0

    Version:

    1.0

    Summary

    Data Fields

    Details

    Field Documentation

    Description:

    Obtains the API specific to the default feature.

    You need to call this function before using the system capabilities of the service involved.

    Name

    Description

    service Indicates the name of the service to which the default feature belongs.

    Returns:

    Returns the * object that can be called if the operation is successful; returns NULL if the operation fails.

    GetFeatureApi

    Description:

    Obtains the API specific to the feature.

    You need to call this function before using the system capabilities of the service involved.

    Parameters:

    Name

    Description

    service Indicates the name of the service to which the feature belongs.
    feature Indicates the name of the feature whose API will be obtained.

    Returns:

    Returns the IUnknown * object that can be called if the operation is successful; returns NULL if the operation fails.

    RegisterDefaultFeatureApi

    1. BOOL(* SamgrLite::RegisterDefaultFeatureApi) (const char *service, [IUnknown]($api-api-SmartVision-Devices-IUnknown.md) *publicApi)

    Description:

    Registers the API for the default feature of a service.

    You need to call this function after the service is registered. The pointers to the IUnknown and members to be registered cannot be empty.

    Parameters:

    Returns:

    Returns TRUE if the registration is successful; returns FALSE if the registration fails.

    RegisterFeature

    Description:

    Registers a feature.

    You need to call this function in the startup entry of each feature. Feature and structure members to be registered cannot be empty.

    Parameters:

    Name

    Description

    feature Indicates the feature to be registered.

    Returns:

    Returns TRUE if the registration is successful; returns FALSE if the registration fails.

    RegisterFeatureApi

    Description:

    Registers the API for a feature.

    You can call this function only if the feature has been registered. The pointers to the IUnknown and members to be registered cannot be empty.

    Parameters:

    Name

    Description

    service Indicates the name of the service whose API will be registered.
    feature Indicates the name of the feature whose API will be registered.
    publicApi Indicates the API to be registered.

    Returns:

    Returns TRUE if the registration is successful; returns FALSE if the registration fails.

    1. BOOL(* SamgrLite::RegisterService) ([Service]($api-api-SmartVision-Devices-Service.md) *service)

    Description:

    Registers a service.

    You need to call this function in the startup entry of each service. and Service structure members to be registered cannot be empty.

    Returns:

    Returns TRUE if the registration is successful; returns FALSE if the registration fails.

    UnregisterDefaultFeatureApi

    Description:

    Unregisters the API from the default feature of a service.

    You need to call this function to unregister if the service to which the default feature belongs is no longer required.

    Parameters:

    Name

    Description

    service Indicates the name of the service whose default feature’s API will be unregistered.

    Returns:

    Returns the unregistered function object if the unregistration is successful. The memory is released by the caller. Returns NULL if the unregistration fails.

    UnregisterFeature

    Description:

    Unregisters a feature.

    You need to call this function when the feature is no longer required.

    Parameters:

    Name

    Description

    serviceName Indicates the name of the service whose feature will be unregistered.
    featureName Indicates the name of the feature to be unregistered.

    Attention:

    Before unregistering the feature, you must unregister its functions. Otherwise, the unregistration fails.

    Returns:

    Returns the unregistered feature object if the unregistration is successful. The memory is released by the caller. Returns NULL if the unregistration fails.

    UnregisterFeatureApi

      Description:

      Unregisters the API from a feature.

      You must call this function before unregistering the feature no longer required.

      Parameters:

      Returns:

      Returns the unregistered function object if the unregistration is successful. The memory is released by the caller. Returns NULL if the unregistration fails.

      UnregisterService

      Description:

      Unregisters a service.

      You need to call this function when the service is no longer required.

      Parameters:

      Name

      Description

      name Indicates the name of the service to be unregistered.

      Attention:

      Before unregistering the service, you must unregister its features and functions.

      Returns: