diff --git a/IPCKit/ipc_cparcel.h b/IPCKit/ipc_cparcel.h index 6903bb6214c825872da586926a7ef65fc8a582a1..937387d9e7ac8166e46cb06b19352cbcbcf6fe76 100644 --- a/IPCKit/ipc_cparcel.h +++ b/IPCKit/ipc_cparcel.h @@ -19,7 +19,6 @@ * * @brief Defines C interfaces for IPC serialization and deserialization. * - * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ @@ -46,7 +45,6 @@ extern "C" { /** * @brief Defines an IPC serialized object. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ struct OHIPCParcel; @@ -54,7 +52,6 @@ struct OHIPCParcel; /** * @brief Typedef an IPC serialized object. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ typedef struct OHIPCParcel OHIPCParcel; @@ -62,7 +59,6 @@ typedef struct OHIPCParcel OHIPCParcel; /** * @brief Defines an IPC remote proxy object. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ struct OHIPCRemoteProxy; @@ -70,7 +66,6 @@ struct OHIPCRemoteProxy; /** * @brief Typedef an IPC remote proxy object. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ typedef struct OHIPCRemoteProxy OHIPCRemoteProxy; @@ -78,7 +73,6 @@ typedef struct OHIPCRemoteProxy OHIPCRemoteProxy; /** * @brief Defines an IPC remote service object. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ struct OHIPCRemoteStub; @@ -86,7 +80,6 @@ struct OHIPCRemoteStub; /** * @brief Typedef an IPC remote service object. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ typedef struct OHIPCRemoteStub OHIPCRemoteStub; @@ -94,7 +87,6 @@ typedef struct OHIPCRemoteStub OHIPCRemoteStub; /** * @brief Allocates memory. * - * @syscap SystemCapability.Communication.IPC.Core * @param len Length of the memory to allocate. * @return Returns the address of the memory allocated if the operation is successful; returns NULL otherwise. * @since 12 @@ -104,7 +96,6 @@ typedef void* (*OH_IPC_MemAllocator)(int32_t len); /** * @brief Creates an OHIPCParcel object, which cannot exceed 204,800 bytes. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns the pointer to the OHIPCParcel object created if the operation is successful; * returns NULL otherwise. * @since 12 @@ -114,7 +105,6 @@ OHIPCParcel* OH_IPCParcel_Create(void); /** * @brief Destroys an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the OHIPCParcel object to destroy. * @since 12 */ @@ -123,7 +113,6 @@ void OH_IPCParcel_Destroy(OHIPCParcel *parcel); /** * @brief Obtains the size of the data contained in an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the data size obtained if the operation is successful.\n * Returns -1 if invalid parameters are found. @@ -134,7 +123,6 @@ int OH_IPCParcel_GetDataSize(const OHIPCParcel *parcel); /** * @brief Obtains the number of bytes that can be written to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the number of bytes that can be written to the OHIPCParcel object. \n * Returns -1 if invalid parameters are found. @@ -145,7 +133,6 @@ int OH_IPCParcel_GetWritableBytes(const OHIPCParcel *parcel); /** * @brief Obtains the number of bytes that can be read from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the number of bytes that can be read from the OHIPCParcel object. \n * Returns -1 if invalid parameters are found. @@ -156,7 +143,6 @@ int OH_IPCParcel_GetReadableBytes(const OHIPCParcel *parcel); /** * @brief Obtains the position where data is read in an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the position obtained if the operation is successful. \n * Returns -1 if invalid parameters are found. @@ -167,7 +153,6 @@ int OH_IPCParcel_GetReadPosition(const OHIPCParcel *parcel); /** * @brief Obtains the position where data is written in an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the position obtained if the operation is successful. \n * Returns -1 if invalid parameters are found. @@ -178,7 +163,6 @@ int OH_IPCParcel_GetWritePosition(const OHIPCParcel *parcel); /** * @brief Resets the position to read data in an IPC parcel. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param newReadPos New position to read data. The value ranges from 0 to the current data size. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -190,7 +174,6 @@ int OH_IPCParcel_RewindReadPosition(OHIPCParcel *parcel, uint32_t newReadPos); /** * @brief Resets the position to write data in an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param newWritePos New position to write data. The value ranges from 0 to the current data size. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -202,7 +185,6 @@ int OH_IPCParcel_RewindWritePosition(OHIPCParcel *parcel, uint32_t newWritePos); /** * @brief Writes an int8_t value to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Value to write. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -215,7 +197,6 @@ int OH_IPCParcel_WriteInt8(OHIPCParcel *parcel, int8_t value); /** * @brief Reads an int8_t value from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Pointer to the data to read. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -228,7 +209,6 @@ int OH_IPCParcel_ReadInt8(const OHIPCParcel *parcel, int8_t *value); /** * @brief Writes an int16_t value to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Value to write. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -241,7 +221,6 @@ int OH_IPCParcel_WriteInt16(OHIPCParcel *parcel, int16_t value); /** * @brief Reads an int16_t value from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Pointer to the data to read. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -254,7 +233,6 @@ int OH_IPCParcel_ReadInt16(const OHIPCParcel *parcel, int16_t *value); /** * @brief Writes an int32_t value to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Value to write. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -267,7 +245,6 @@ int OH_IPCParcel_WriteInt32(OHIPCParcel *parcel, int32_t value); /** * @brief Reads an int32_t value from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Pointer to the data to read. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -280,7 +257,6 @@ int OH_IPCParcel_ReadInt32(const OHIPCParcel *parcel, int32_t *value); /** * @brief Writes an int64_t value to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Value to write. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -293,7 +269,6 @@ int OH_IPCParcel_WriteInt64(OHIPCParcel *parcel, int64_t value); /** * @brief Reads an int64_t value from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Pointer to the data to read. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -306,7 +281,6 @@ int OH_IPCParcel_ReadInt64(const OHIPCParcel *parcel, int64_t *value); /** * @brief Writes a float value to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Value to write. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -319,7 +293,6 @@ int OH_IPCParcel_WriteFloat(OHIPCParcel *parcel, float value); /** * @brief Reads a float value from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Pointer to the data to read. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -332,7 +305,6 @@ int OH_IPCParcel_ReadFloat(const OHIPCParcel *parcel, float *value); /** * @brief Writes a double value to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Value to write. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -345,7 +317,6 @@ int OH_IPCParcel_WriteDouble(OHIPCParcel *parcel, double value); /** * @brief Reads a double value from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param value Pointer to the data to read. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -358,7 +329,6 @@ int OH_IPCParcel_ReadDouble(const OHIPCParcel *parcel, double *value); /** * @brief Writes a string including a string terminator to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param str String to write, which cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -371,7 +341,6 @@ int OH_IPCParcel_WriteString(OHIPCParcel *parcel, const char *str); /** * @brief Reads a string from an OHIPCParcel object. You can obtain the length of the string from strlen. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the address of the string read if the operation is successful; * returns NULL if the operation fails or invalid parameters are found. @@ -382,7 +351,6 @@ const char* OH_IPCParcel_ReadString(const OHIPCParcel *parcel); /** * @brief Writes data of the specified length from the memory to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param buffer Pointer to the address of the memory information to write. * @param len Length of the data to write. @@ -396,7 +364,6 @@ int OH_IPCParcel_WriteBuffer(OHIPCParcel *parcel, const uint8_t *buffer, int32_t /** * @brief Reads memory information of the specified length from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param len Length of the memory to be read. * @return Returns the memory address read if the operation is successful; @@ -408,7 +375,6 @@ const uint8_t* OH_IPCParcel_ReadBuffer(const OHIPCParcel *parcel, int32_t len); /** * @brief Writes an OHIPCRemoteStub object to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param stub Pointer to the OHIPCRemoteStub object to write. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -421,7 +387,6 @@ int OH_IPCParcel_WriteRemoteStub(OHIPCParcel *parcel, const OHIPCRemoteStub *stu /** * @brief Reads the OHIPCRemoteStub object from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the pointer to the OHIPCRemoteStub object read if the operation is successful; * returns NULL otherwise. @@ -432,7 +397,6 @@ OHIPCRemoteStub* OH_IPCParcel_ReadRemoteStub(const OHIPCParcel *parcel); /** * @brief Writes an OHIPCRemoteProxy object to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param proxy Pointer to the OHIPCRemoteProxy object to write. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -445,7 +409,6 @@ int OH_IPCParcel_WriteRemoteProxy(OHIPCParcel *parcel, const OHIPCRemoteProxy *p /** * @brief Reads the OHIPCRemoteProxy object from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @return Returns the pointer to the OHIPCRemoteProxy object read if the operation is successful; * returns NULL otherwise. @@ -456,7 +419,6 @@ OHIPCRemoteProxy* OH_IPCParcel_ReadRemoteProxy(const OHIPCParcel *parcel); /** * @brief Writes a file descriptor to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param fd File descriptor to write. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -469,7 +431,6 @@ int OH_IPCParcel_WriteFileDescriptor(OHIPCParcel *parcel, int32_t fd); /** * @brief Reads a file descriptor from an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param fd Pointer to the file descriptor to read. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -482,7 +443,6 @@ int OH_IPCParcel_ReadFileDescriptor(const OHIPCParcel *parcel, int32_t *fd); /** * @brief Appends data to an OHIPCParcel object. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param data Pointer to the data to append. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -495,7 +455,6 @@ int OH_IPCParcel_Append(OHIPCParcel *parcel, const OHIPCParcel *data); /** * @brief Writes an interface token to an OHIPCParcel object for interface identity verification. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param token Pointer to the interface token to write. It cannot be NULL. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -508,7 +467,6 @@ int OH_IPCParcel_WriteInterfaceToken(OHIPCParcel *parcel, const char *token); /** * @brief Reads an interface token from an OHIPCParcel object for interface identity verification. * - * @syscap SystemCapability.Communication.IPC.Core * @param parcel Pointer to the target OHIPCParcel object. It cannot be NULL. * @param token Pointer to the address of the memory for storing the interface token. * The memory is allocated by the allocator provided by the user and needs to be released. This pointer cannot be NULL. diff --git a/IPCKit/ipc_cremote_object.h b/IPCKit/ipc_cremote_object.h index 1f04f78dd54ab44a5c9cd888fb699602b8e17eeb..b43a4a780fad459408b1db387a805360f6df69b3 100644 --- a/IPCKit/ipc_cremote_object.h +++ b/IPCKit/ipc_cremote_object.h @@ -20,7 +20,6 @@ * @brief Provides C interfaces for creating and destroying a remote object, transferring data, * and observing the dead status of a remote object. * - * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ @@ -51,7 +50,6 @@ extern "C" { * @brief Defines an OHIPCDeathRecipient object, which is used to receive a notification * when the OHIPCRemoteStub object dies unexpectedly. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ struct OHIPCDeathRecipient; @@ -59,7 +57,6 @@ struct OHIPCDeathRecipient; /** * @brief Typedef an OHIPCDeathRecipient object. * -* @syscap SystemCapability.Communication.IPC.Core * @since 12 */ typedef struct OHIPCDeathRecipient OHIPCDeathRecipient; @@ -67,7 +64,6 @@ typedef struct OHIPCDeathRecipient OHIPCDeathRecipient; /** * @brief Called to process the remote data request at the stub. * - * @syscap SystemCapability.Communication.IPC.Core * @param code Custom command word for communication, in the range [0x01, 0x00ffffff]. * @param data Pointer to the request data object. It cannot be NULL or released in the function. * @param reply Pointer to the response data object. It cannot be NULL or released in the function. @@ -84,7 +80,6 @@ typedef int (*OH_OnRemoteRequestCallback)(uint32_t code, const OHIPCParcel *data /** * @brief Called when an observed object is destroyed. * - * @syscap SystemCapability.Communication.IPC.Core * @param userData Pointer to the user data. It can be NULL. * @since 12 */ @@ -93,7 +88,6 @@ typedef void (*OH_OnRemoteDestroyCallback)(void *userData); /** * @brief Creates an OHIPCRemoteStub object. * - * @syscap SystemCapability.Communication.IPC.Core * @param descriptor Pointer to the descriptor of the OHIPCRemoteStub object to create. It cannot be NULL. * @param requestCallback Callback used to process the data request. It cannot be NULL. * @param destroyCallback Callback to be invoked when the object is destroyed. It can be NULL. @@ -108,7 +102,6 @@ OHIPCRemoteStub* OH_IPCRemoteStub_Create(const char *descriptor, OH_OnRemoteRequ /** * @brief Destroys an OHIPCRemoteStub object. * - * @syscap SystemCapability.Communication.IPC.Core * @param stub Pointer to the OHIPCRemoteStub object to destroy. * @since 12 */ @@ -117,7 +110,6 @@ void OH_IPCRemoteStub_Destroy(OHIPCRemoteStub *stub); /** * @brief Destroys an OHIPCRemoteProxy object. * - * @syscap SystemCapability.Communication.IPC.Core * @param proxy Pointer to the OHIPCRemoteProxy object to destroy. * @since 12 */ @@ -154,7 +146,6 @@ typedef struct { /** * @brief Sends an IPC message. * - * @syscap SystemCapability.Communication.IPC.Core * @param proxy Pointer to the OHIPCRemoteProxy object. It cannot be NULL. * @param code Custom IPC command word, in the range [0x01, 0x00ffffff]. * @param data Pointer to the request data object. It cannot be NULL. @@ -174,7 +165,6 @@ int OH_IPCRemoteProxy_SendRequest(const OHIPCRemoteProxy *proxy, uint32_t code, /** * @brief Obtains the interface descriptor from the stub. * - * @syscap SystemCapability.Communication.IPC.Core * @param proxy Pointer to the OHIPCRemoteProxy object. It cannot be NULL. * @param descriptor Double pointer to the address of the memory for holding the interface descriptor. * The memory is allocated by the allocator provided by the user and needs to be released. This pointer cannot be NULL. @@ -197,7 +187,6 @@ int OH_IPCRemoteProxy_GetInterfaceDescriptor(OHIPCRemoteProxy *proxy, char **des /** * @brief Called when the OHIPCRemoteStub object dies unexpectedly. * - * @syscap SystemCapability.Communication.IPC.Core * @param userData Pointer to the user data. It can be NULL. * @since 12 */ @@ -206,7 +195,6 @@ typedef void (*OH_OnDeathRecipientCallback)(void *userData); /** * @brief Called when the OHIPCDeathRecipient object is destroyed. * - * @syscap SystemCapability.Communication.IPC.Core * @param userData Pointer to the user data. It can be NULL. * @since 12 */ @@ -216,7 +204,6 @@ typedef void (*OH_OnDeathRecipientDestroyCallback)(void *userData); * @brief Creates an OHIPCDeathRecipient object, which allows a notification to be received * when the OHIPCRemoteStub object dies unexpectedly. * - * @syscap SystemCapability.Communication.IPC.Core * @param deathRecipientCallback Callback to be invoked when the OHIPCRemoteStub object is dead. * It cannot be NULL. * @param destroyCallback Callback to be invoked when the object is destroyed. It can be NULL. @@ -231,7 +218,6 @@ OHIPCDeathRecipient* OH_IPCDeathRecipient_Create(OH_OnDeathRecipientCallback dea /** * @brief Destroys an OHIPCDeathRecipient object. * - * @syscap SystemCapability.Communication.IPC.Core * @param recipient Pointer to the OHIPCDeathRecipient object to destroy. * @since 12 */ @@ -240,7 +226,6 @@ void OH_IPCDeathRecipient_Destroy(OHIPCDeathRecipient *recipient); /** * @brief Subscribes to the death of an OHIPCRemoteStub object for an OHIPCRemoteProxy object. * - * @syscap SystemCapability.Communication.IPC.Core * @param proxy Pointer to the OHIPCRemoteProxy object that subscribes to the death notification. * It cannot be NULL. * @param recipient Pointer to the object that receives the death notification of the OHIPCRemoteStub object. @@ -255,7 +240,6 @@ int OH_IPCRemoteProxy_AddDeathRecipient(OHIPCRemoteProxy *proxy, OHIPCDeathRecip /** * @brief Unsubscribes from the death of the OHIPCRemoteStub object for an OHIPCRemoteProxy object. * - * @syscap SystemCapability.Communication.IPC.Core * @param proxy Pointer to the OHIPCRemoteProxy object that unsubscribes from the death notification. * It cannot be NULL. * @param recipient Pointer to the object that receives the death notification of the OHIPCRemoteStub object. @@ -270,7 +254,6 @@ int OH_IPCRemoteProxy_RemoveDeathRecipient(OHIPCRemoteProxy *proxy, OHIPCDeathRe /** * @brief Checks whether the OHIPCRemoteStub object corresponding to the OHIPCRemoteProxy object is dead. * - * @syscap SystemCapability.Communication.IPC.Core * @param proxy Pointer to the OHIPCRemoteProxy object to check. It cannot be NULL. * @return Returns 1 if the OHIPCRemoteStub object is dead; returns 0 otherwise. * If an invalid parameter is found, the OHIPCRemoteStub object does not exist. diff --git a/IPCKit/ipc_cskeleton.h b/IPCKit/ipc_cskeleton.h index e6a8530139c843a5652c02da0805961bdebd22a6..4b93d270a821fc16d716df37800abd34c57d0b6c 100644 --- a/IPCKit/ipc_cskeleton.h +++ b/IPCKit/ipc_cskeleton.h @@ -20,7 +20,6 @@ * @brief Provides C interfaces for managing the token IDs, credentials, process IDs (PIDs), * user IDs (UIDs), and thread pool in the IPC framework. * - * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ @@ -50,7 +49,6 @@ extern "C" { /** * @brief Joints this thread to the IPC worker thread pool. * - * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ void OH_IPCSkeleton_JoinWorkThread(void); @@ -58,7 +56,6 @@ void OH_IPCSkeleton_JoinWorkThread(void); /** * @brief Stops this thread. * - * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ void OH_IPCSkeleton_StopWorkThread(void); @@ -67,7 +64,6 @@ void OH_IPCSkeleton_StopWorkThread(void); * @brief Obtains the token ID of the caller. This function must be called in the IPC context. * Otherwise, the local token ID is returned. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns the token ID of the caller. * @since 12 */ @@ -76,7 +72,6 @@ uint64_t OH_IPCSkeleton_GetCallingTokenId(void); /** * @brief Obtains the token ID of the first caller. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns the token ID obtained. * @since 12 */ @@ -85,7 +80,6 @@ uint64_t OH_IPCSkeleton_GetFirstTokenId(void); /** * @brief Obtains the local token ID. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns the token ID obtained. * @since 12 */ @@ -95,7 +89,6 @@ uint64_t OH_IPCSkeleton_GetSelfTokenId(void); * @brief Obtains the process ID of the caller. This function must be called in the IPC context. * Otherwise, the current process ID is returned. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns the process ID of the caller. * @since 12 */ @@ -105,7 +98,6 @@ uint64_t OH_IPCSkeleton_GetCallingPid(void); * @brief Obtains the UID of the caller. This function must be called in the IPC context. * Otherwise, the current UID is returned. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns the UID of the caller. * @since 12 */ @@ -114,7 +106,6 @@ uint64_t OH_IPCSkeleton_GetCallingUid(void); /** * @brief Checks whether a local calling is being made. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns 1 if a local calling is in progress; returns 0 otherwise. * @since 12 */ @@ -123,7 +114,6 @@ int OH_IPCSkeleton_IsLocalCalling(void); /** * @brief Sets the maximum number of worker threads. * - * @syscap SystemCapability.Communication.IPC.Core * @param maxThreadNum Maximum number of worker threads to set. The default value is 16. * The value range is [1, 32]. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -138,7 +128,6 @@ int OH_IPCSkeleton_SetMaxWorkThreadNum(const int maxThreadNum); * returns the caller credential information. * The identity information is used in OH_IPCSkeleton_SetCallingIdentity. * - * @syscap SystemCapability.Communication.IPC.Core * @param identity Pointer to the address of the memory for holding the caller identity information. * The memory is allocated by the allocator provided by the user and needs to be released. This pointer cannot be NULL. * @param len Pointer to the length of the identity information. It cannot be NULL. @@ -154,7 +143,6 @@ int OH_IPCSkeleton_ResetCallingIdentity(char **identity, int32_t *len, OH_IPC_Me /** * @brief Sets the caller credential information to the IPC context. * - * @syscap SystemCapability.Communication.IPC.Core * @param identity Pointer to the caller identity, which cannot be NULL. * The value is returned by OH_IPCSkeleton_ResetCallingIdentity. * @return Returns {@link OH_IPC_ErrorCode#OH_IPC_SUCCESS} if the operation is successful. \n @@ -167,7 +155,6 @@ int OH_IPCSkeleton_SetCallingIdentity(const char *identity); /** * @brief Checks whether an IPC request is being handled. * - * @syscap SystemCapability.Communication.IPC.Core * @return Returns 1 if an IPC request is being handled; returns 0 otherwise. * @since 12 */ diff --git a/IPCKit/ipc_error_code.h b/IPCKit/ipc_error_code.h index 5fa109e5b0336476872c6c8aea8ca7dfed840165..b4739211db686529860fc901351a071d7920bfc7 100644 --- a/IPCKit/ipc_error_code.h +++ b/IPCKit/ipc_error_code.h @@ -19,7 +19,6 @@ * * @brief Provides IPC error codes. * - * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ diff --git a/IPCKit/ipc_kit.h b/IPCKit/ipc_kit.h index 9786bd1f25622ba4751fd8fd7aa0e915c801babb..a6e7d74580fc61b989a012b4ddc8f3e0308b440b 100644 --- a/IPCKit/ipc_kit.h +++ b/IPCKit/ipc_kit.h @@ -19,16 +19,16 @@ * * @brief Provides an entry to the IPC header files for you to reference. * - * @syscap SystemCapability.Communication.IPC.Core * @since 12 */ /** - * @file ipc_cparcel.h + * @file ipc_kit.h * * @brief Provides an entry to the IPC header files for you to reference. * * @library libipc_capi.so + * @kit IPCKit * @syscap SystemCapability.Communication.IPC.Core * @since 12 */