SamgrLite

Overview

Related Modules:

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

Variable Name

Description

RegisterService )(Serviceservice)

BOOL( 

Registers a service.

UnregisterService )(const char name)

Service ( 

Unregisters a service.

RegisterFeature )(const char serviceName, Featurefeature)

BOOL( 

Registers a feature.

UnregisterFeature )(const char serviceName, const char featureName)

Feature( 

Unregisters a feature.

RegisterDefaultFeatureApi )(const char service, IUnknownpublicApi)

BOOL( 

Registers the API for the default feature of a service.

UnregisterDefaultFeatureApi )(const char service)

IUnknown( 

Unregisters the API from the default feature of a service.

RegisterFeatureApi )(const char service, const char feature, IUnknownpublicApi)

BOOL( 

Registers the API for a feature.

UnregisterFeatureApi )(const char service, const char feature)

IUnknown( 

Unregisters the API from a feature.

GetDefaultFeatureApi )(const char service)

IUnknown ( 

Obtains the API specific to the default feature.

GetFeatureApi )(const char serviceName, const char feature)

IUnknown (* 

Obtains the API specific to the feature.

Details

Field Documentation

GetDefaultFeatureApi

  1. [IUnknown]($api-api-LinkIoT-IUnknown.md)*(*SamgrLite::GetDefaultFeatureApi)(constchar*service)

Description:

Obtains the API specific to the default feature.

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

Parameters:

Name

Description

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

Returns:

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

GetFeatureApi

  1. [IUnknown]($api-api-LinkIoT-IUnknown.md)*(*SamgrLite::GetFeatureApi)(constchar*serviceName,constchar*feature)

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

serviceIndicates the name of the service to which the feature belongs.
featureIndicates 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)(constchar*service,[IUnknown]($api-api-LinkIoT-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 IUnknown members to be registered cannot be empty.

Parameters:

Name

Description

serviceIndicates the name of the service whose default feature’s API will be registered.
publicApiIndicates the API to be registered.

Returns:

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

RegisterFeature

  1. BOOL(*SamgrLite::RegisterFeature)(constchar*serviceName,[Feature]($api-api-LinkIoT-Feature.md)*feature)

Description:

Registers a feature.

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

Parameters:

Name

Description

featureIndicates the feature to be registered.

Returns:

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

RegisterFeatureApi

  1. BOOL(*SamgrLite::RegisterFeatureApi)(constchar*service,constchar*feature,[IUnknown]($api-api-LinkIoT-IUnknown.md)*publicApi)

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 IUnknown members to be registered cannot be empty.

Parameters:

Name

Description

serviceIndicates the name of the service whose API will be registered.
featureIndicates the name of the feature whose API will be registered.
publicApiIndicates the API to be registered.

Returns:

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

RegisterService

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

Description:

Registers a service.

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

Parameters:

Name

Description

serviceIndicates the service to be registered.

Returns:

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

UnregisterDefaultFeatureApi

  1. [IUnknown]($api-api-LinkIoT-IUnknown.md)*(*SamgrLite::UnregisterDefaultFeatureApi)(constchar*service)

Description:

Unregisters the API from the default feature of a service.

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

Parameters:

Name

Description

serviceIndicates 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

  1. [Feature]($api-api-LinkIoT-Feature.md)*(*SamgrLite::UnregisterFeature)(constchar*serviceName,constchar*featureName)

Description:

Unregisters a feature.

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

Parameters:

Name

Description

serviceNameIndicates the name of the service whose feature will be unregistered.
featureNameIndicates 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

  1. [IUnknown]($api-api-LinkIoT-IUnknown.md)*(*SamgrLite::UnregisterFeatureApi)(constchar*service,constchar*feature)

Description:

Unregisters the API from a feature.

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

Parameters:

Name

Description

serviceIndicates the name of the service whose API will be unregistered.
featureIndicates the name of the feature whose 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.

UnregisterService

  1. [Service]($api-api-LinkIoT-Service.md)*(*SamgrLite::UnregisterService)(constchar*name)

Description:

Unregisters a service.

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

Parameters:

Name

Description

nameIndicates the name of the service to be unregistered.

Attention:

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

Returns:

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